deployer & gateway: added OpenAPI docs #794
Merged
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 of change
Added deployer & gateway OpenAPI spec. The raw openapi specs endpoints are scoped to Admin users that will be authorized through an API key. Example for gateway reachable on my localhost:
For gateway openapi spec:
curl -H "Authorization: Bearer test-key" localhost:8001/api-docs/openapi.json
For a specific project deployer:
curl -H "Authorization: Bearer test-key" localhost:8001/projects/{project_name}/api-docs/openapi.json (a specific project deployer docs).
How Has This Been Tested (if applicable)?
Generated the deployer & gateway open api specs and validated them here: https://editor.swagger.io/?_ga=2.66167150.1903807504.1681801827-1400620191.1681387801.
Disclaimer