-
Notifications
You must be signed in to change notification settings - Fork 2
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 OpenAPI support #159
Open
lukasturcani
wants to merge
40
commits into
nomad-nmr:main
Choose a base branch
from
lukasturcani:lukas/open-api
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add OpenAPI support #159
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.
This PR adds boilerpate allowing the creation of Swagger documentation via the
swagger-ui-express
dependency.The first endpoint im adding is
/api/v2/auto-experiments
which allows the querying and filtering ofauto-experiments
How it works
nomad-rest-api/app.js
: Has a new object calledswaggerDocument
this object documents the api and is used to generate the Swagger docs. For each path, an object which defines the api of that path is added. I'm defining these objects incontrolers/v2/auto-experiments.js
so that the documentation object is next to the function it is documenting./api-docs
where you can view the swagger documentation -- see image belownomad-rest-api/contorllers/auth.js
- ive added a documentation boject for the auth endpoint so that it appears in the swagger docs- ive added enpoints for
/api/v2/auto-expeirmentsand
/api/v2/auto-experiments/download`