Add support for examples in OpenAPI block #2314
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
Eloutmanixx
approved these changes
May 14, 2024
SamyPesse
requested changes
May 15, 2024
scazan
approved these changes
May 20, 2024
taranvohra
approved these changes
May 21, 2024
SamyPesse
requested changes
May 21, 2024
There was a problem hiding this comment.
IMO it can't be merged in the current state and it requires more work:
- Properly support non-primitive values?
- should we represent with
JSON.stringify? If yes, it'll not work well for XML/etc API - should we skip non-primitives using
typeof schema.example === 'string' || typeof schema.example === 'number' || typeof schema.example === 'boolean'?
- should we represent with
- Should we handle
examplesas well by selecting the first example or the one matching the media-type?
SamyPesse
reviewed
May 21, 2024
|
@SamyPesse this is blocking for an ICP customer going live with their API docs. I think Vib made the requested changes. Can we get it to move? |
SamyPesse
requested changes
Jun 20, 2024
SamyPesse
approved these changes
Jun 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Same description as #2313