Redocly / museum-openapi-example

An example OpenAPI description for an imaginary Museum API.
https://redocly.com/docs/resources/learning-openapi/
MIT License
36 stars 36 forks source link

Refactor: Uncouple from HTTP and use data models #32

Open lornajane opened 2 months ago

lornajane commented 2 months ago

What/Why/How?

When we created the Museum API, we stopped iterating at the HTTP data transfer level. This PR doesn't change much of the API description (removed phone numbers from ticket records) but takes a more RESTful approach of modelling entities.

Still needs work: since the ID fields are readonly, I ran into https://github.com/Redocly/redocly-cli/issues/1416 which marks the examples as invalid.

Check yourself

Security