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

Updated api docs with optional fields #3483

Merged
merged 2 commits into from
Mar 30, 2022

Conversation

Saranya-jena
Copy link
Contributor

@Saranya-jena Saranya-jena commented Mar 7, 2022

Signed-off-by: Saranya-jena [email protected]

Proposed changes

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 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:

@codesniffy codesniffy bot added the size/L label Mar 7, 2022
@@ -7,7 +7,7 @@ schemes:
info:
title: Litmus Portal Authentication API

Choose a reason for hiding this comment

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

Suggested change
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:

Choose a reason for hiding this comment

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

Suggested change
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

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>

Choose a reason for hiding this comment

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

Could you please change

<td>Mandatory</td>

to

<td>Optional</td>

@imrajdas imrajdas merged commit 5396173 into litmuschaos:master Mar 30, 2022
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.

4 participants