Skip to content

docs(asm): add 403 Forbidden response to all API endpoints #20

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

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

docs(asm): add 403 Forbidden response to all API endpoints #20

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
34 changes: 34 additions & 0 deletions asm/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ paths:
$ref: '#/components/schemas/Asset'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'

Expand All @@ -119,6 +121,8 @@ paths:
$ref: '#/components/schemas/AssetDetail'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
patch:
Expand All @@ -143,6 +147,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
delete:
Expand All @@ -157,6 +163,8 @@ paths:
description: Asset archived
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'

Expand Down Expand Up @@ -189,6 +197,8 @@ paths:
$ref: '#/components/schemas/Scan'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
post:
operationId: triggerScan
summary: Trigger scan
Expand All @@ -213,6 +223,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'

Expand All @@ -239,6 +251,8 @@ paths:
$ref: '#/components/schemas/ScanDetail'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'

Expand Down Expand Up @@ -292,6 +306,8 @@ paths:
$ref: '#/components/schemas/Vulnerability'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'

/vulnerabilities/{vuln_id}:
parameters:
Expand All @@ -316,6 +332,8 @@ paths:
$ref: '#/components/schemas/VulnerabilityDetail'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
patch:
Expand All @@ -340,6 +358,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'

Expand All @@ -362,6 +382,8 @@ paths:
$ref: '#/components/schemas/Tag'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
post:
operationId: createTag
summary: Create tag
Expand Down Expand Up @@ -392,6 +414,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'

components:
securitySchemes:
Expand Down Expand Up @@ -438,6 +462,16 @@ components:
error:
code: unauthorized
message: Invalid or missing Bearer token
Forbidden:
description: Valid credentials but insufficient permissions for this resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: forbidden
message: You do not have permission to access this resource
NotFound:
description: Resource not found
content:
Expand Down
Loading