Skip to content

fix(asm): add missing 429 responses and document rate-limit headers #31

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(asm): add missing 429 responses and document rate-limit headers #31

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
36 changes: 36 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 @@ -363,6 +379,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 @@ -394,6 +412,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'

components:
securitySchemes:
Expand Down Expand Up @@ -429,6 +449,18 @@ components:
pattern: '^ast_[a-z0-9]{16}$'
example: ast_1a2b3c4d5e6f0001

headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute for this API key
schema:
type: integer
example: 600
X-RateLimit-Remaining:
description: Number of requests remaining in the current one-minute window
schema:
type: integer
example: 542

responses:
Unauthorized:
description: Missing or invalid API key
Expand Down Expand Up @@ -463,6 +495,10 @@ components:
schema:
type: integer
description: Seconds until the rate limit window resets
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down
Loading