Updated API documentations #481
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
Signed-off-by: Xuhang Cao <ccao@oberlin.edu>
Xiaocao-Cxh
requested review from
lumjjb,
mrsabath,
mamy-CS and
maia-iyer
as code owners
maia-iyer
approved these changes
Aug 27, 2024
Signed-off-by: Xuhang Cao <ccao@oberlin.edu>
Closed
Closed
maia-iyer
pushed a commit
that referenced
this pull request
Sep 17, 2024
* Updated API documentations Signed-off-by: Xuhang Cao <ccao@oberlin.edu> * Fixing nits Signed-off-by: Xuhang Cao <ccao@oberlin.edu> --------- Signed-off-by: Xuhang Cao <ccao@oberlin.edu>
maia-iyer
pushed a commit
that referenced
this pull request
Sep 17, 2024
* Updated API documentations Signed-off-by: Xuhang Cao <ccao@oberlin.edu> * Fixing nits Signed-off-by: Xuhang Cao <ccao@oberlin.edu> --------- Signed-off-by: Xuhang Cao <65797697+Xiaocao-Cxh@users.noreply.github.com>
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.
Updates all APIs available that can be referred to in
tornjak-ui-api-documentation.md. But I believe we still miss/api/v1/tornjak/agents. Also, three warning forrequestBodycomes from 3 delete APIs: "requestBody does not have well-defined semantics for GET, HEAD and DELETE operations."Explanation: The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible.
The warning exists only on Swagger Editor, but otherwise looks perfect on VS Code and IntelliJ.