Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update: documentation for the Chaoscenter Authentication REST API #5012

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

namkyu1999
Copy link
Member

@namkyu1999 namkyu1999 commented Jan 4, 2025

Proposed changes

This PR updates authentication api document from v2.0.0 to v3.14.0

Changes contain...

  • Change the documentation generation tool from spectacle to redoc. Because spectacle does not update anymore. The last commit was 3 years ago.
  • add omitted APIs
  • add descriptions and fix typos

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 x in the boxes that apply

  • New feature (non-breaking change which adds functionality)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices applies)

Checklist

Put an x in 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.

  • I have read the CONTRIBUTING doc
  • I have signed the commit for DCO to be passed.
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added necessary documentation (if appropriate)

Dependency

  • Please add the links to the dependent PR need to be merged before this (if any).

Special notes for your reviewer:

@namkyu1999 namkyu1999 marked this pull request as ready for review January 4, 2025 07:18
@namkyu1999 namkyu1999 self-assigned this Jan 4, 2025
c.JSON(http.StatusOK, gin.H{
"message": "Successful",
})
c.JSON(http.StatusOK, response.MessageResponse{Message: "Successful"})
Copy link
Contributor

@jemlog jemlog Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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'. 🙂

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I understand your opinion. However, in this PR, I want to ensure that the return values remain unchanged.

@jemlog
Copy link
Contributor

jemlog commented Jan 14, 2025

LGTM

@Saranya-jena
Copy link
Contributor

@namkyu1999 could you please check the unit test, one of them is failing.

@namkyu1999
Copy link
Member Author

done @Saranya-jena

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API documentation for the latest versions and add it to litmus-docs
3 participants