Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example before the specification #2034

Closed
fulldecent opened this issue Oct 19, 2019 · 4 comments
Closed

Add example before the specification #2034

fulldecent opened this issue Oct 19, 2019 · 4 comments
Assignees
Labels
editorial Wording and stylistic issues examples requests for more or better examples in the specification
Milestone

Comments

@fulldecent
Copy link

Regarding the OpenAPI homepage.

The specification goes directly into grammar and details. But nobody has shown me what the OpenAPI specification looks like. An example text file/device/robot/planet/other thing which complies with the specification should be shown as a specimen to explain what OpenAPI is.

@aghorpade
Copy link

@fulldecent - I guess you need to take a look at https://petstore.swagger.io/ to understand what OpenAPI specification looks like once you use them.

@fulldecent
Copy link
Author

Proposed fix at #2299

@handrews handrews added the examples requests for more or better examples in the specification label Jan 28, 2024
@lornajane
Copy link
Contributor

I think we could signpost the (newer than this issue) resources at https://learn.openapis.org to support this request.

@handrews handrews added the editorial Wording and stylistic issues label May 24, 2024
@handrews handrews self-assigned this May 24, 2024
@handrews handrews added this to the v3.0.4 milestone May 24, 2024
@handrews
Copy link
Member

PR for the part of this warranting a spec change is merged for 3.0.4 and ported to 3.1.1 via PR #3921!
As noted above, the rest of this belongs with the Learn repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Wording and stylistic issues examples requests for more or better examples in the specification
Projects
None yet
Development

No branches or pull requests

4 participants