IBX-9058: Complete REST API #161
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related PRs:
Description:
About JSON examples
In Redocly output, while XML examples are OK, JSON examples are one-lined with
\n
. It seems that an object example should be a YAML object, not a single JSON string. I didn't find anexample:
example but this is howexamples:
works according to specifications and https://redocly.com/learn/openapi/openapi-visual-reference/example. The fix help to have JSON well interpreted in the Redocly output, an unfoldable object easier to navigate.Before, without the fix:

After, with the fix:

For QA:
Documentation: