Document the API via OpenAPI #3252
Merged
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
elia
reviewed
Jul 9, 2019
cedum
reviewed
Jul 9, 2019
|
@elia commits separated! |
elia
approved these changes
Jul 9, 2019
cedum
approved these changes
Jul 9, 2019
kennyadsl
approved these changes
Jul 9, 2019
jacobherrington
approved these changes
Jul 10, 2019
This was referenced Jul 10, 2019
kennyadsl
added
changelog:solidus_api
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.
Description
Documents our API endpoints using the OpenAPI Specification.
With this format, we have machine-readable API documentation that can be consumed by a number of different tools to generate static HTML documentation, spin up a mock server, validate the documentation against a real API and much more.
Currently, this documentation is managed and hosted on Stoplight. The idea is that we put it in this GitHub repository, then update it whenever the API is changed. A CircleCI job will then copy the documentation to Stoplight and publish a new version of the static documentation when a Solidus version is released. The minor Solidus version (e.g. 2.9) will be used as the Stoplight version.
As a nice bonus, the CircleCI configuration has also been updated to take advantage of 2.1 features such as executors and commands.
Checklist: