museum-openapi-example
museum-openapi-example copied to clipboard
Redocly
An example OpenAPI description for an imaginary Museum API.
## What/Why/How? If a customer needs to cancel their ticket for a refund, this API endpoint can be used to look up the ticket by ID and delete it. Also...
Thank you for offering a new example for OpenAPI! It is widely understood that APIs should avoid HTTP Basic Auth, which is inherently insecure. I recommend revising the Museum OpenAPI...
## What/Why/How? Initial pass at creating a membership system with multiple tiers for museum patrons. issue #17 Submitted for feedback! ## Reference ## Testing ## Screenshots (optional) ## Check yourself...
## What/Why/How? ## Reference ## Testing ## Screenshots (optional) ## Check yourself - [ ] Code is linted - [ ] Tested with redoc/reference-docs/workflows (internal) - [ ] All new/updated...
## What/Why/How? It seemed like it would be a good idea to add museum ticket types for students (reduced price) and children aged 0-5 (free) so that there are a...
## What/Why/How? ## Reference ## Testing ## Screenshots (optional) ## Check yourself - [ ] Code is linted - [ ] Tested with redoc/reference-docs/workflows (internal) - [ ] All new/updated...
Museums often offer annual memberships to guest with special perks. This could be implemented into the spec. Some methods could include: Add member Update member Change membership upgrade membership downgrade...
We have both staff and user endpoints in the Museum API. Tag them separately and show an example of filtering (see: https://redocly.com/docs/cli/decorators/filter-in/) just one of the tags into a bundle.
The issue template is the default one we use on our code projects, which isn't a great fit for a community-driven participation repository. Let's update it to be welcoming and...
We're currently falling back to the organization default template which makes no sense in the context of this project. Update the template to be lightweight, but encourage users to say...