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.

Sign up for GitHub

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

Jump to bottom

Updates /register and /report API return status codes description #93

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updates /register and /report API return status codes description #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ paths:
'200':
schema:
$ref: "#/definitions/RegisterResponse"
description: Repository registered
description: Git repository is registered for scan at Gemini API server.
'400':
description: Bad request from the client
Copy link
Author

Choose a reason for hiding this comment

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

@abs51295 @samuzzal-choudhury : Why do we have 400 for /register API call?

'401':
description: Request unauthorized
description: Unauthorized request from the client. Kindly if check access token is valid or expired.
'404':
Copy link
Author

Choose a reason for hiding this comment

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

What does 404 mean for /register API call ?

description: Data not found
'500':
description: Internal server error
description: Internal server error!
/report:
get:
tags:
Expand All @@ -77,15 +77,15 @@ paths:
'200':
schema:
$ref: "#/definitions/Report"
description: Scan report for given registered repository
description: Scan report is generated at the Gemini API server.
'400':
description: Bad request from the client
description: dependency/version-lock/manifest file is absent in the referenced git repo at provided git-sha. Unable to scan and generate report at the Gemini API server.
'401':
description: Request unauthorized
description: Unauthorized request from the client. Kindly check if the access token is valid or expired.
'404':
description: Data not found
description: Report is not found at the Gemini API server, processing is in progress, kindly check back in sometime.
'500':
description: Internal server error
description: Internal server error!
'/user-repo/scan':
post:
tags:
Expand Down