-
Notifications
You must be signed in to change notification settings - Fork 705
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
Updated api docs with optional fields #3483
Conversation
Signed-off-by: Saranya-jena <[email protected]>
@@ -7,7 +7,7 @@ schemes: | |||
info: | |||
title: Litmus Portal Authentication API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Litmus Portal Authentication API | |
title: Litmus Portal Authentication API | |
version: 1.0.0 |
Missing version information in info is giving error when tested swagger.yml
on https://editor.swagger.io/
email: [email protected] | ||
name: user1 | ||
role: admin | ||
created_at: "1627040098" | ||
schema: | ||
type: object | ||
produces: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
produces: | |
parameters: | |
- name: user_id | |
required: true | |
description: Id of the user | |
in: path | |
type: string | |
produces: |
Gives error Declared path parameter "user_id" needs to be defined as a path parameter at either the path or operation level
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar error for /get_project/{project_id}
and /get_user_with_project/{username}
target="_blank" | ||
>Authentication</a | ||
> | ||
</section> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please change
litmus/mkdocs/docs/graphql/v2.0.0/api.html
Line 604 in f801670
<td>Mandatory</td> |
to
<td>Optional</td>
Signed-off-by: Saranya-jena <[email protected]>
Signed-off-by: Saranya-jena [email protected]
Proposed changes
Fixing issues from (ChaosCenter): API Testing issues tracker litmus-e2e#362
Summarize your changes here to communicate with the maintainers and make sure to put the link of that issue
Types of changes
What types of changes does your code introduce to Litmus? Put an
x
in the boxes that applyChecklist
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.Dependency
Special notes for your reviewer: