feat: Update API examples list to include Museum API #2506
Conversation
…n playground for local dev and some minor edits to redoc name
There was a problem hiding this comment.
Left few comments.
In general, I really like it. Finally, we will have a new example. 🙌
What do you think about adding more complicated examples (discriminator, oneOf, markdown with SchemaDefinition, if/then/else, additional properties, etc)? Not all of that but a few useful cases, I believe, it will make the example more fancy and useful. 🚀
| type: number | ||
| format: float | ||
| example: 25 | ||
| CreateSpecialEventRequest: |
There was a problem hiding this comment.
It is never used. Is it expected? I believe, we should use it in CreateSpecialEvent operation.
| ticketType: event | ||
| ticketDate: 2023-09-05 | ||
| confirmationCode: ticket-event-9c55eg-8v82a | ||
| CreateSpecialEventRequestExample: |
There was a problem hiding this comment.
It is never used. Should we use it with CreateSpecialEvent operation?
| - 2023-09-05 | ||
| - 2023-09-08 | ||
| price: 0 | ||
| CreateSpecialEventResponseExample: |
There was a problem hiding this comment.
The same, it is never used.
| - 2023-09-05 | ||
| - 2023-09-08 | ||
| price: 15 | ||
| GetMuseumHours: |
There was a problem hiding this comment.
the same. this example is not using.
| - date: '2023-09-22' | ||
| timeOpen: '10:00' | ||
| timeClose: '16:00' | ||
| ClosedMuseumHours: |
There was a problem hiding this comment.
Not used. Is it expected?
| type: string | ||
| format: date | ||
| example: 2023-02-23 | ||
| EndDate: |
There was a problem hiding this comment.
we do not have ref for this. I believe we should use in inside listSpecialEvents operation
|
This is useful feedback, could you please add it over on the museum project https://github.com/Redocly/museum-openapi-example which is the source of truth for this file? We can bring a new version in to this project when we have one. The purpose of this pull request is to use our existing Museum API as the main demo on https://github.com/Redocly/museum-openapi-example. I hope that you can help me to package it and push the correct content to the We can publish new Museum API versions as that project improves and evolves - but we need the demo updated with whatever we have, as soon as we can. |
What/Why/How?
We have more modern examples that Redoc works pretty well with - so let's use them.
Fixes #2473
Check yourself