redocly / museum-openapi-example Goto Github PK
View Code? Open in Web Editor NEWAn example OpenAPI description for an imaginary Museum API.
Home Page: https://redocly.com/docs/resources/learning-openapi/
License: MIT License
An example OpenAPI description for an imaginary Museum API.
Home Page: https://redocly.com/docs/resources/learning-openapi/
License: MIT License
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 example to use a more secure security scheme.
oauth2
security scheme (with authorizationCode
flow and with specific read and write scopes -- scope names left to implementors) or openIdConnect
security schemesecurity
requirement with write or other scope.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 what they are changing and WHY so we can review.
When replacing the Petstore API with the Musuem API in the Redocly monorepo, our linting found some issues in the API like missing punctuation, quotation marks, etc, that needed to be updated. So this issue is to make those minor updates and moves the repeated 400 errors into the components section so that $refs can be used.
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 relevant.
I ran prettier to make the API description more consistent, but we should automate that so it runs every time.
The source openapi.yaml contains
license:
name: MIT
url: "https://opensource.org/license/mit/ "
with a trailing space. This should be
license:
name: MIT
url: "https://opensource.org/license/mit/"
(I can submit a PR to fix this)
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.
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 membership
cancel membership
Find member
Apply member discount
add membership level
update membership level
I noticed the license inside of the openapi.yaml (Apache 2) mismatches the license in the repo (MIT). Should we align to MIT?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.