Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
22.88k stars 2.26k forks source link

feat: Update API examples list to include Museum API #2506

Closed lornajane closed 2 months ago

lornajane commented 3 months ago

What/Why/How?

We have more modern examples that Redoc works pretty well with - so let's use them.

Fixes #2473

Check yourself

lornajane commented 3 months ago

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 gh-pages branch. We need this for an upcoming event, and the issue had been open quite a while.

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.