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

Incorporate documentation for the Chaoscenter REST API #4197

Merged
merged 15 commits into from
Nov 15, 2023

Conversation

Freedisch
Copy link
Contributor

Proposed changes

This PR consist to add API documentation for Chaoscenter REST API
For this I'm using 2 library

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:

Signed-off-by: Freedisch <freeproduc@gmail.com>
Signed-off-by: Freedisch <freeproduc@gmail.com>
@Freedisch Freedisch changed the title Swagger Incorporate documentation for the Chaoscenter REST API Sep 30, 2023
@namkyu1999 namkyu1999 added the LFX-MENTORSHIP Linux Foundation Mentor ship Issue label Oct 3, 2023
@Freedisch
Copy link
Contributor Author

docs sample
API documentation and 61 more pages - Personal - Microsoft​ Edge 10_11_2023 2_45_00 AM

Copy link
Member

@S-ayanide S-ayanide left a comment

Choose a reason for hiding this comment

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

There is an import order issue with this file ./chaoscenter/authentication/api/handlers/doc.go which is also failing the backend build.

Rest LGTM

@@ -5,48 +5,74 @@ go 1.20
require (
github.com/coreos/go-oidc/v3 v3.1.0
github.com/gin-contrib/cors v1.3.1
github.com/gin-gonic/gin v1.7.7
github.com/gin-gonic/gin v1.9.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we have upgraded the version of gin gonic, can you confirm if it is working fine and there are no breaking changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Checking it...

Freedisch and others added 6 commits November 8, 2023 09:28
Signed-off-by: freedisch <freeproduc@gmail.com>
Signed-off-by: Magnim BATALE <82499435+Freedisch@users.noreply.github.com>
Signed-off-by: freedisch <freeproduc@gmail.com>
Signed-off-by: freedisch <freeproduc@gmail.com>
Signed-off-by: freedisch <freeproduc@gmail.com>
@Saranya-jena
Copy link
Contributor

@Freedisch the backend checks are failing, could you format the code?

Signed-off-by: freedisch <freeproduc@gmail.com>
Copy link
Contributor

@SarthakJain26 SarthakJain26 left a comment

Choose a reason for hiding this comment

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

Requested one minor change

chaoscenter/authentication/api/handlers/doc.go Outdated Show resolved Hide resolved
Signed-off-by: freedisch <freeproduc@gmail.com>
Signed-off-by: freedisch <freeproduc@gmail.com>
Signed-off-by: freedisch <freeproduc@gmail.com>
@Saranya-jena Saranya-jena merged commit eabfc5e into litmuschaos:master Nov 15, 2023
14 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LFX-MENTORSHIP Linux Foundation Mentor ship Issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants