Referencing Examples
Hi Guys, I am trying to understand how to reference examples, I have two example endpoints: GET /badge -> {Badge} GET /badges -> [Badges] So I would like to use the same example but in th...
Forum Discussion
Hey me_slack. How are you rendering the reporting in those screenshots? Is that Swagger UI, or some other environment?
According to RFC3986, the $ref string value (JSON Reference) should contain a URI, which identifies the location of the JSON value you are referencing to. If the string value does not conform URI syntax rules, it causes an error during the resolving. Any members other than $ref in a JSON Reference object are ignored.
You can find examples of references here: https://swagger.io/docs/specification/using-ref/
Hi joejoyce
As it's a nodejs app, I am using openapi-comment-parser to build the JSON, which uses a YAML file to store the details.
Then I render this JSON file via Redoc
The JSON lives here: https://api.juicyllama.com/docs/openapi.json
And the docs live: https://api.juicyllama.com/#tag/Webhook
Thanks for replying.
Thanks for the extra info.
I did a quick test there by importing the JSON from here (https://api.juicyllama.com/docs/openapi.json) into SwaggerHub to see how it would be rendered by the documentation. The result looked like this:
Which looks to me like we are picking up the reference and rendering it correctly. Have you tried rendering the JSON using Swagger UI instead of Redoc, as a test? Because SwaggerHub seems to think that the JSON is valid.
