Skip to content

docs(asm): document X-RateLimit-Limit/Remaining response headers on all endpoints #23

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): document X-RateLimit-Limit/Remaining response headers on all endpoints #23

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
72 changes: 72 additions & 0 deletions asm/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ paths:
responses:
'200':
description: Paginated list of assets
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down Expand Up @@ -113,6 +118,11 @@ paths:
responses:
'200':
description: Asset detail
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand All @@ -135,6 +145,11 @@ paths:
responses:
'200':
description: Updated asset
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand All @@ -155,6 +170,11 @@ paths:
responses:
'204':
description: Asset archived
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
Expand All @@ -176,6 +196,11 @@ paths:
responses:
'200':
description: Paginated list of scans
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down Expand Up @@ -205,6 +230,11 @@ paths:
responses:
'202':
description: Scan accepted and queued
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down Expand Up @@ -233,6 +263,11 @@ paths:
responses:
'200':
description: Scan detail
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down Expand Up @@ -279,6 +314,11 @@ paths:
responses:
'200':
description: Paginated list of vulnerability findings
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down Expand Up @@ -310,6 +350,11 @@ paths:
responses:
'200':
description: Vulnerability detail
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand All @@ -332,6 +377,11 @@ paths:
responses:
'200':
description: Updated vulnerability
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand All @@ -351,6 +401,11 @@ paths:
responses:
'200':
description: All tags in the tenant
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand Down Expand Up @@ -384,6 +439,11 @@ paths:
responses:
'201':
description: Tag created
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
Expand All @@ -394,6 +454,18 @@ paths:
$ref: '#/components/responses/Unauthorized'

components:
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute for the current API key.
schema:
type: integer
example: 600
X-RateLimit-Remaining:
description: Number of requests remaining in the current rate-limit window.
schema:
type: integer
example: 543

securitySchemes:
bearerAuth:
type: http
Expand Down
Loading