REST API docs via OpenAPI #316
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
bourque
requested review from
sdhoyt,
greglucas,
tech3371,
laspsandoval and
maxinelasp
bourque
commented
Jan 19, 2024
bourque
commented
Jan 19, 2024
maxinelasp
approved these changes
Jan 19, 2024
greglucas
reviewed
Jan 19, 2024
There was a problem hiding this comment.
This looks great!!
I think all of our API is going through query parameters right now. Do we want to change any of those to path parameters on the backend?
I added quite a few comments on the content of the API/server that are unrelated to this PR, so feel free to ignore them and just consider them left there for us to think about updating on the backend.
tech3371
reviewed
Jan 19, 2024
sdhoyt
reviewed
Jan 23, 2024
|
@greglucas @sdhoyt I pushed some changes that hopefully reflect what we are likely to merge in with #317 and IMAP-Science-Operations-Center/sds-data-manager#228. There will still likely be some tweaks we will want to make, but I think this is a good starting point. We should discuss this at our next meeting. |
laspsandoval
pushed a commit
to laspsandoval/imap_processing
that referenced
this pull request
Apr 2, 2024
…enapi REST API docs via OpenAPI
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.
Change Summary
Overview
This PR adds a new documentation page that describes our REST API. It is mostly auto-generated using OpenAPI, though I added some customized examples.
New Dependencies
sphinxcontrib-openapi--sphinxextension to support auto-generated OpenAPI docsNew Files
docs/source/rest-api/index.rstdocs/source/rest-api/openapi.ymlUpdated Files
docs/source/conf.pysphinxcontrib-openapiextensiondocs/source/index.rstpyproject.tomlandpoetry.locksphinxcontrib-openapidependency