Skip to content

Commit f83d9fe

Browse files
github-actions[bot]github-actions[bot]
authored
fix(openapi): sync with openapi definition (#510)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent d2c2c00 commit f83d9fe

2 files changed

Lines changed: 67 additions & 33 deletions

File tree

‎openapi.json‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17374,7 +17374,7 @@
1737417374
"name": "sort",
1737517375
"in": "query",
1737617376
"required": false,
17377-
"description": "",
17377+
"description": "Field to sort by. One of: created_at, updated_at.",
1737817378
"schema": {
1737917379
"type": "string",
1738017380
"default": "created_at"
@@ -17384,7 +17384,7 @@
1738417384
"name": "direction",
1738517385
"in": "query",
1738617386
"required": false,
17387-
"description": "",
17387+
"description": "Sort direction. One of: asc, desc.",
1738817388
"schema": {
1738917389
"type": "string",
1739017390
"default": "desc"
@@ -17394,7 +17394,7 @@
1739417394
"name": "per_page",
1739517395
"in": "query",
1739617396
"required": false,
17397-
"description": "",
17397+
"description": "Number of results per page (1–100, default 30).",
1739817398
"schema": {
1739917399
"type": "integer",
1740017400
"minimum": 1,
@@ -17406,7 +17406,7 @@
1740617406
"name": "page",
1740717407
"in": "query",
1740817408
"required": false,
17409-
"description": "",
17409+
"description": "Page number (1-based).",
1741017410
"schema": {
1741117411
"type": "integer",
1741217412
"minimum": 1,
@@ -17426,7 +17426,7 @@
1742617426
]
1742717427
}
1742817428
],
17429-
"description": "Get alert triage actions for an organization.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-list",
17429+
"description": "List triage actions for an organization. Results are paginated and can be sorted by created_at or updated_at.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-list",
1743017430
"responses": {
1743117431
"200": {
1743217432
"content": {
@@ -17616,7 +17616,7 @@
1761617616
"tags": [
1761717617
"triage"
1761817618
],
17619-
"summary": "Update Org Alert Triage",
17619+
"summary": "Create/Update Org Alert Triage",
1762017620
"operationId": "updateOrgAlertTriage",
1762117621
"parameters": [
1762217622
{
@@ -17655,43 +17655,43 @@
1765517655
"properties": {
1765617656
"uuid": {
1765717657
"type": "string",
17658-
"description": "",
17658+
"description": "The UUID of the triage entry. Omit to create a new entry; provide to update an existing one.",
1765917659
"default": "",
1766017660
"nullable": true
1766117661
},
1766217662
"packageType": {
1766317663
"type": "string",
17664-
"description": "",
17664+
"description": "The package ecosystem type (e.g., npm, pypi). Use null or \"*\" for wildcard.",
1766517665
"default": "",
1766617666
"nullable": true
1766717667
},
1766817668
"packageNamespace": {
1766917669
"type": "string",
17670-
"description": "",
17670+
"description": "The package namespace or scope. Use null or \"*\" for wildcard.",
1767117671
"default": "",
1767217672
"nullable": true
1767317673
},
1767417674
"packageName": {
1767517675
"type": "string",
17676-
"description": "",
17676+
"description": "The package name. Use null or \"*\" for wildcard.",
1767717677
"default": "",
1767817678
"nullable": true
1767917679
},
1768017680
"packageVersion": {
1768117681
"type": "string",
17682-
"description": "",
17682+
"description": "The package version. Supports a \"*\" suffix for wildcard prefix matching. Use null for any version.",
1768317683
"default": "",
1768417684
"nullable": true
1768517685
},
1768617686
"alertKey": {
1768717687
"type": "string",
17688-
"description": "",
17688+
"description": "The specific alert key to target.",
1768917689
"default": "",
1769017690
"nullable": true
1769117691
},
1769217692
"alertType": {
1769317693
"type": "string",
17694-
"description": "",
17694+
"description": "The alert type (e.g., criticalCVE, highCVE).",
1769517695
"default": "",
1769617696
"nullable": true
1769717697
},
@@ -17724,7 +17724,7 @@
1772417724
},
1772517725
"cveOrGhsaId": {
1772617726
"type": "string",
17727-
"description": "",
17727+
"description": "CVE or GHSA ID to match against.",
1772817728
"default": "",
1772917729
"nullable": true
1773017730
},
@@ -17740,13 +17740,13 @@
1774017740
},
1774117741
"cvssScoreCmp": {
1774217742
"type": "string",
17743-
"description": "",
17743+
"description": "CVSS score comparison operator and value (e.g., >=7.5, >5.0, ==8.0).",
1774417744
"default": "",
1774517745
"nullable": true
1774617746
},
1774717747
"note": {
1774817748
"type": "string",
17749-
"description": "",
17749+
"description": "A note or comment for the triage action.",
1775017750
"default": ""
1775117751
},
1775217752
"state": {
@@ -17786,7 +17786,7 @@
1778617786
]
1778717787
}
1778817788
],
17789-
"description": "Update triage actions on organization alerts.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-update",
17789+
"description": "Create or update triage actions on organization alerts. Accepts a batch of triage entries. Omit `uuid` to create a new entry; provide an existing `uuid` to update it. Use `?force=true` for broad triages that lack a specific `alertKey` or granular package information.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-update",
1779017790
"responses": {
1779117791
"200": {
1779217792
"content": {

‎types/api.d.ts‎

Lines changed: 50 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ export interface paths {
466466
'/orgs/{org_slug}/triage/alerts': {
467467
/**
468468
* List Org Alert Triage
469-
* @description Get alert triage actions for an organization.
469+
* @description List triage actions for an organization. Results are paginated and can be sorted by created_at or updated_at.
470470
*
471471
* This endpoint consumes 1 unit of your quota.
472472
*
@@ -475,8 +475,8 @@ export interface paths {
475475
*/
476476
get: operations['getOrgTriage']
477477
/**
478-
* Update Org Alert Triage
479-
* @description Update triage actions on organization alerts.
478+
* Create/Update Org Alert Triage
479+
* @description Create or update triage actions on organization alerts. Accepts a batch of triage entries. Omit `uuid` to create a new entry; provide an existing `uuid` to update it. Use `?force=true` for broad triages that lack a specific `alertKey` or granular package information.
480480
*
481481
* This endpoint consumes 1 unit of your quota.
482482
*
@@ -7477,7 +7477,7 @@ export interface operations {
74777477
}
74787478
/**
74797479
* List Org Alert Triage
7480-
* @description Get alert triage actions for an organization.
7480+
* @description List triage actions for an organization. Results are paginated and can be sorted by created_at or updated_at.
74817481
*
74827482
* This endpoint consumes 1 unit of your quota.
74837483
*
@@ -7487,9 +7487,13 @@ export interface operations {
74877487
getOrgTriage: {
74887488
parameters: {
74897489
query?: {
7490+
/** @description Field to sort by. One of: created_at, updated_at. */
74907491
sort?: string
7492+
/** @description Sort direction. One of: asc, desc. */
74917493
direction?: string
7494+
/** @description Number of results per page (1–100, default 30). */
74927495
per_page?: number
7496+
/** @description Page number (1-based). */
74937497
page?: number
74947498
}
74957499
path: {
@@ -7612,8 +7616,8 @@ export interface operations {
76127616
}
76137617
}
76147618
/**
7615-
* Update Org Alert Triage
7616-
* @description Update triage actions on organization alerts.
7619+
* Create/Update Org Alert Triage
7620+
* @description Create or update triage actions on organization alerts. Accepts a batch of triage entries. Omit `uuid` to create a new entry; provide an existing `uuid` to update it. Use `?force=true` for broad triages that lack a specific `alertKey` or granular package information.
76177621
*
76187622
* This endpoint consumes 1 unit of your quota.
76197623
*
@@ -7635,19 +7639,40 @@ export interface operations {
76357639
content: {
76367640
'application/json': {
76377641
alertTriage: Array<{
7638-
/** @default */
7642+
/**
7643+
* @description The UUID of the triage entry. Omit to create a new entry; provide to update an existing one.
7644+
* @default
7645+
*/
76397646
uuid?: string | null
7640-
/** @default */
7647+
/**
7648+
* @description The package ecosystem type (e.g., npm, pypi). Use null or "*" for wildcard.
7649+
* @default
7650+
*/
76417651
packageType?: string | null
7642-
/** @default */
7652+
/**
7653+
* @description The package namespace or scope. Use null or "*" for wildcard.
7654+
* @default
7655+
*/
76437656
packageNamespace?: string | null
7644-
/** @default */
7657+
/**
7658+
* @description The package name. Use null or "*" for wildcard.
7659+
* @default
7660+
*/
76457661
packageName?: string | null
7646-
/** @default */
7662+
/**
7663+
* @description The package version. Supports a "*" suffix for wildcard prefix matching. Use null for any version.
7664+
* @default
7665+
*/
76477666
packageVersion?: string | null
7648-
/** @default */
7667+
/**
7668+
* @description The specific alert key to target.
7669+
* @default
7670+
*/
76497671
alertKey?: string | null
7650-
/** @default */
7672+
/**
7673+
* @description The alert type (e.g., criticalCVE, highCVE).
7674+
* @default
7675+
*/
76517676
alertType?: string | null
76527677
/**
76537678
* @description Whether a fix is available, unavailable, or * for any
@@ -7664,16 +7689,25 @@ export interface operations {
76647689
* @enum {string}
76657690
*/
76667691
kevs?: 'exist' | 'none' | '*'
7667-
/** @default */
7692+
/**
7693+
* @description CVE or GHSA ID to match against.
7694+
* @default
7695+
*/
76687696
cveOrGhsaId?: string | null
76697697
/**
76707698
* @description The reachability of the alert, can be reachable, unreachable, other, or * for any
76717699
* @enum {string}
76727700
*/
76737701
reachability?: 'reachable' | 'unreachable' | 'other' | '*'
7674-
/** @default */
7702+
/**
7703+
* @description CVSS score comparison operator and value (e.g., >=7.5, >5.0, ==8.0).
7704+
* @default
7705+
*/
76757706
cvssScoreCmp?: string | null
7676-
/** @default */
7707+
/**
7708+
* @description A note or comment for the triage action.
7709+
* @default
7710+
*/
76777711
note?: string
76787712
/**
76797713
* @description The triage state of the alert

0 commit comments

Comments
 (0)