Skip to content

fix: add missing 429 responses to all ASM API endpoints #26

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

fix: add missing 429 responses to all ASM API endpoints #26

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
31 changes: 31 additions & 0 deletions asm/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ paths:
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
patch:
operationId: updateAsset
summary: Update asset
Expand All @@ -145,6 +147,8 @@ paths:
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
delete:
operationId: deleteAsset
summary: Archive asset
Expand All @@ -159,6 +163,8 @@ paths:
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'

/scans:
get:
Expand Down Expand Up @@ -189,6 +195,8 @@ paths:
$ref: '#/components/schemas/Scan'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
post:
operationId: triggerScan
summary: Trigger scan
Expand Down Expand Up @@ -241,6 +249,8 @@ paths:
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'

/vulnerabilities:
get:
Expand Down Expand Up @@ -292,6 +302,8 @@ paths:
$ref: '#/components/schemas/Vulnerability'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'

/vulnerabilities/{vuln_id}:
parameters:
Expand All @@ -318,6 +330,8 @@ paths:
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
patch:
operationId: updateVulnerability
summary: Update vulnerability
Expand All @@ -342,6 +356,8 @@ paths:
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'

/tags:
get:
Expand All @@ -362,6 +378,8 @@ paths:
$ref: '#/components/schemas/Tag'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
post:
operationId: createTag
summary: Create tag
Expand Down Expand Up @@ -392,6 +410,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'

components:
securitySchemes:
Expand Down Expand Up @@ -454,6 +474,13 @@ components:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: validation_error
message: Request body contains invalid fields
details:
- field: tags[0]
message: Tag name must not exceed 64 characters
RateLimited:
description: Rate limit exceeded
headers:
Expand All @@ -465,6 +492,10 @@ components:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: rate_limit_exceeded
message: API rate limit of 600 requests per minute exceeded

schemas:
# ── Enums ──────────────────────────────────────────────────────────────────
Expand Down
Loading