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

chore(docs): Update auth-server api docs (support 3.11.0) #4910

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

suyeon-jung-dev
Copy link
Contributor

@suyeon-jung-dev suyeon-jung-dev commented Oct 2, 2024

Proposed changes

This PR adds:

  • Update auth-server swagger files.
    • v3.10.0
    • v3.11.0
  • Change the documentation generation tool from spectacle to redoc
    • Because spectacle does not update anymore. The last commit was 3 years ago.

Demo Links is here: https://suyeon-jung-dev.github.io/litmus/auth/v3.11.0/api.html

Resolves #4771

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

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