Add HTTP API Documentation#3
Merged
simeoncarstens merged 5 commits intotweag/http-apifrom Feb 1, 2024
Merged
Conversation
simeoncarstens
requested changes
Jan 31, 2024
Member
simeoncarstens
left a comment
simeoncarstens
left a comment
There was a problem hiding this comment.
Thanks for these changes! I made two small suggestions. Could you also add a paragraph / section in the main README that tells how to start the API, and mention the link to the auto-generated API docs site?
Co-authored-by: Simeon Carstens <simeon.carstens@tweag.io>
Co-authored-by: Simeon Carstens <simeon.carstens@tweag.io>
simeoncarstens
force-pushed
the
tweag/http-api-add-documentation
branch
from
257e09d to
638479f
Compare
simeoncarstens
approved these changes
Feb 1, 2024
simeoncarstens
added a commit
that referenced
this pull request
Feb 1, 2024
* Apply formatter * Add documentation for `POST` and `GET` requests * Update looper/api/main.py Co-authored-by: Simeon Carstens <simeon.carstens@tweag.io> * Update looper/api/main.py Co-authored-by: Simeon Carstens <simeon.carstens@tweag.io> * Add where to access the API documentation --------- Co-authored-by: Simeon Carstens <simeon.carstens@tweag.io>
This file contains hidden or 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
2 participants
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
This PR introduces comprehensive documentation for the HTTP API, covering the
main_endpointandstatusendpoints. Additionally, code formatting has been applied.Changes Made
HTTP API Documentation:
main_endpointproviding details on its purpose.statusendpoint for retrieving job status.Code Formatting:
black.How to Test
api/README.md)./docsand/redocendpoints to review the newly added documentation.