Swagger "Could not resolve pointer" with namespaced keys

[arichiardi]

Hi there, from Slack, opening a bug report for a problem we have when using reitit.swagger/create-swagger-handler.

We register malli spec with a namespace:

(r/register! :survey/site-type [:enum ...])

and we use it in another schema, say:

(def survey
  [:map [:type :survey/type])

The generated ref for the parent object is "#ref": "$ref":"#/definitions/survey~1site-type" while in "definitions" we see {"survey/site-type": ...}.

This results in a Swagger error: Could not resolve reference: Could not resolve pointer: #/definitions/survey~1site-type.

Thanks for taking a look - let me know if you want me to test the fix locally.

[frenchy64]

This seems like the correct output. Are you able to post a more complete (but minimal) example? Or at least the relevant parts of the swagger.json?

[arichiardi]

I can try yes to have a minimal example but I guess it cannot be correct if swagger is returning a big red error.

[frenchy64]

It could be a frontend problem like:

• Models names containing / and ~ are displayed with ~1 and ~0 instead swagger-api/swagger-ui#4161
• Slashes in $ref do not work following RFC 6901 swagger-api/swagger-ui#1793

[arichiardi]

Oh I see what you mean now. I somehow thought the two would need to match.

To put it another way you are saying that #/definitions/survey~1site-type should correctly refer to survey/site-type (as per first link).

Thanks btw - I have just read that I guess we probably should not use them anyway (see swagger-api/swagger-ui#4161 (comment)).

[frenchy64]

Maybe they do need to match in some tooling, and probably openapi.

I see that even reitit's openapi support does exactly the same thing ~1 https://github.com/metosin/reitit/blob/58195eed68bc3413704c20e95b4bf7bd7abb8c7e/test/cljc/reitit/openapi_test.clj#L1002

Though it mentions this is banned in openapi https://github.com/metosin/reitit/blob/58195eed68bc3413704c20e95b4bf7bd7abb8c7e/test/cljc/reitit/openapi_test.clj#L1023-L1025

[opqdonut]

Yes this whole thing with / is very unfortunate. The best thing for our users would probably be to map / to something like _ or . instead.

[arichiardi]

@opqdonut the problem is that if you use namespaced keys in your malli schema you would get / in your swagger...that is why I would probably rather see the malli swagger transformer do that conversion for you if it is against the spec (or some version, for instance 3.1 or something)

[opqdonut]

Yes! To be clear, what I meant was: malli should replace / with something else when generating swagger / json-schema.