Provide example of where this project is talking about #2299
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MikeRalphson
suggested changes
Aug 10, 2020
| @@ -15,6 +15,10 @@ The OpenAPI Specification does not require rewriting existing APIs. It does not | |||
|
|
|||
| This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project. | |||
|
|
|||
| Here is an example API description file following the OpenAPI Specification: https://petstore.swagger.io/v2/swagger.json | |||
There was a problem hiding this comment.
As we have examples within the repo, I think it would be a mistake to link outside to one particular vendor's example.
| @@ -15,6 +15,10 @@ The OpenAPI Specification does not require rewriting existing APIs. It does not | |||
|
|
|||
| This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project. | |||
|
|
|||
| Here is an example API description file following the OpenAPI Specification: https://petstore.swagger.io/v2/swagger.json | |||
|
|
|||
| And here is an API documentation website rendered automatically from that file: https://petstore.swagger.io | |||
There was a problem hiding this comment.
Because of the range of open-source and commercial solutions providing documentation renderers (as well as this only being one use-case for an OpenAPI document), I think it would be better to remove this entirely.
|
Closing due to inactivity - but please feel free to reopen the PR if necessary. With the changes requested, this PR would be verging on the empty anyway. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An example is worth a 1000-word README.