WIP: Bug 1863077 - Add OpenAPI spec for REST APIOpen api #2143
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
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.
Bug 1863077 - Add OpenAPI spec for REST APIFor the discussion about adding an OpenAPI spec to BMO, check out the bug above.
Although there already exists this GitHub repository, which was somewhat helpful in getting started, a lot of the information in that repo is outdated. I basically had to start over again.
What is implemented so far?
How can I see what is currently implemented?
View automatically generated documentation:
For ease of use, I recommend checking out Redoc:
Installation: Redoc Usage
Once installed, run:
Generate a client:
Here, I would recommend OpenAPI Generator.
Install and run:
This should generate a Python client under
/tmp.