Update: documentation for the Chaoscenter Authentication REST API #5012
+1,236
−2,876
Conversation
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
Signed-off-by: namkyu1999 <[email protected]>
Signed-off-by: namkyu1999 <[email protected]>
Signed-off-by: namkyu1999 <[email protected]>
Signed-off-by: namkyu1999 <[email protected]>
namkyu1999
force-pushed
the
rest-api-docs
branch
from
d18354d to
a121b20
Compare
namkyu1999
requested review from
Saranya-jena,
SarthakJain26,
S-ayanide and
amityt
Signed-off-by: namkyu1999 <[email protected]>
Signed-off-by: namkyu1999 <[email protected]>
jemlog
reviewed
Jan 14, 2025
| c.JSON(http.StatusOK, gin.H{ | ||
| "message": "Successful", | ||
| }) | ||
| c.JSON(http.StatusOK, response.MessageResponse{Message: "Successful"}) |
There was a problem hiding this comment.
Hi @namkyu1999, It’s really a trivial point but I think it's better to unify the capitalization.
For example, other MessageResponses are using 'successful' but here is 'Successful'. 🙂
There was a problem hiding this comment.
Yes, I understand your opinion. However, in this PR, I want to ensure that the return values remain unchanged.
|
LGTM |
|
@namkyu1999 could you please check the unit test, one of them is failing. |
Signed-off-by: namkyu1999 <[email protected]>
|
done @Saranya-jena |
S-ayanide
approved these changes
Mar 27, 2025
ispeakc0de
approved these changes
Mar 28, 2025
Calvinaud
pushed a commit
to Calvinaud/litmus
that referenced
this pull request
May 20, 2025
…tmuschaos#5012) * fix: update swagger details Signed-off-by: namkyu1999 <[email protected]> * feat: add authentication api document Signed-off-by: namkyu1999 <[email protected]> * feat: add auth api documentation using redoc Signed-off-by: namkyu1999 <[email protected]> * remove auto generated files Signed-off-by: namkyu1999 <[email protected]> * fix: update response objects Signed-off-by: namkyu1999 <[email protected]> * chore: add new docs Signed-off-by: namkyu1999 <[email protected]> * chore: passed tests Signed-off-by: namkyu1999 <[email protected]> --------- Signed-off-by: namkyu1999 <[email protected]> Signed-off-by: Calvin Audier <[email protected]>
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.
Proposed changes
This PR updates authentication api document from v2.0.0 to v3.14.0
Changes contain...
There are no functional changes; only modifications to the documentation.
Demo Links is here: https://namkyu-park99.github.io/litmus/auth/v3.14.0/api.html
Resolves #4771 litmuschaos/litmus-docs#296
ref #4910
Types of changes
What types of changes does your code introduce to Litmus? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Dependency
Special notes for your reviewer: