Skip to content

Commit 9d23a8b

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

File tree

2 files changed

+71
-14
lines changed

2 files changed

+71
-14
lines changed

‎openapi.json‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29311,7 +29311,7 @@
2931129311
"name": "filters.repoLabels",
2931229312
"in": "query",
2931329313
"required": false,
29314-
"description": "Comma-separated list of repo labels that should be included",
29314+
"description": "Comma-separated list of repo labels that should be included. Use \"\" to filter for repositories with no labels.",
2931529315
"schema": {
2931629316
"type": "string"
2931729317
}
@@ -29320,7 +29320,7 @@
2932029320
"name": "filters.repoLabels.notIn",
2932129321
"in": "query",
2932229322
"required": false,
29323-
"description": "Comma-separated list of repo labels that should be excluded",
29323+
"description": "Comma-separated list of repo labels that should be excluded. Use \"\" to filter for repositories with no labels.",
2932429324
"schema": {
2932529325
"type": "string"
2932629326
}
@@ -29998,7 +29998,7 @@
2999829998
"description": "",
2999929999
"default": ""
3000030000
},
30001-
"description": "Comma-separated list of repo labels that should be excluded"
30001+
"description": "Comma-separated list of repo labels that should be excluded. Use \"\" to filter for repositories with no labels."
3000230002
},
3000330003
"alertType": {
3000430004
"type": "array",
@@ -30271,7 +30271,7 @@
3027130271
"name": "filters.repoLabels",
3027230272
"in": "query",
3027330273
"required": false,
30274-
"description": "Comma-separated list of repo labels that should be included",
30274+
"description": "Comma-separated list of repo labels that should be included. Use \"\" to filter for repositories with no labels.",
3027530275
"schema": {
3027630276
"type": "string"
3027730277
}
@@ -30280,7 +30280,7 @@
3028030280
"name": "filters.repoLabels.notIn",
3028130281
"in": "query",
3028230282
"required": false,
30283-
"description": "Comma-separated list of repo labels that should be excluded",
30283+
"description": "Comma-separated list of repo labels that should be excluded. Use \"\" to filter for repositories with no labels.",
3028430284
"schema": {
3028530285
"type": "string"
3028630286
}
@@ -30689,7 +30689,7 @@
3068930689
"description": "",
3069030690
"default": ""
3069130691
},
30692-
"description": "Comma-separated list of repo labels that should be excluded"
30692+
"description": "Comma-separated list of repo labels that should be excluded. Use \"\" to filter for repositories with no labels."
3069330693
},
3069430694
"alertType": {
3069530695
"type": "array",
@@ -33208,7 +33208,8 @@
3320833208
"spy",
3320933209
"typo",
3321033210
"secret",
33211-
"obf"
33211+
"obf",
33212+
"dual"
3321233213
],
3321333214
"default": "mal"
3321433215
}
@@ -33488,7 +33489,8 @@
3348833489
"spy",
3348933490
"typo",
3349033491
"secret",
33491-
"obf"
33492+
"obf",
33493+
"dual"
3349233494
],
3349333495
"default": "mal"
3349433496
}
@@ -34113,6 +34115,29 @@
3411334115
"x-readme": {}
3411434116
}
3411534117
},
34118+
"/openapi.json": {
34119+
"get": {
34120+
"tags": [
34121+
"Metadata"
34122+
],
34123+
"summary": "Returns the OpenAPI definition",
34124+
"operationId": "getOpenAPIJSON",
34125+
"security": [],
34126+
"description": "Retrieve the API specification in an Openapi JSON format.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:",
34127+
"responses": {
34128+
"200": {
34129+
"content": {
34130+
"application/json": {}
34131+
},
34132+
"description": "OpenAPI specification"
34133+
},
34134+
"429": {
34135+
"$ref": "#/components/responses/SocketTooManyRequestsResponse"
34136+
}
34137+
},
34138+
"x-readme": {}
34139+
}
34140+
},
3411634141
"/quota": {
3411734142
"get": {
3411834143
"tags": [

‎types/api.d.ts‎

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1236,6 +1236,17 @@ export interface paths {
12361236
*/
12371237
get: operations['getOpenAPI']
12381238
}
1239+
'/openapi.json': {
1240+
/**
1241+
* Returns the OpenAPI definition
1242+
* @description Retrieve the API specification in an Openapi JSON format.
1243+
*
1244+
* This endpoint consumes 1 unit of your quota.
1245+
*
1246+
* This endpoint requires the following org token scopes:
1247+
*/
1248+
get: operations['getOpenAPIJSON']
1249+
}
12391250
'/quota': {
12401251
/**
12411252
* Get quota
@@ -11698,9 +11709,9 @@ export interface operations {
1169811709
'filters.repoSlug'?: string
1169911710
/** @description Comma-separated list of repo slugs that should be excluded */
1170011711
'filters.repoSlug.notIn'?: string
11701-
/** @description Comma-separated list of repo labels that should be included */
11712+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
1170211713
'filters.repoLabels'?: string
11703-
/** @description Comma-separated list of repo labels that should be excluded */
11714+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
1170411715
'filters.repoLabels.notIn'?: string
1170511716
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
1170611717
'filters.alertType'?: string
@@ -11879,7 +11890,7 @@ export interface operations {
1187911890
alertSeverity?: string[]
1188011891
/** @description Comma-separated list of repo slugs that should be excluded */
1188111892
repoSlug?: string[]
11882-
/** @description Comma-separated list of repo labels that should be excluded */
11893+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
1188311894
repoLabels?: string[]
1188411895
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
1188511896
alertType?: string[]
@@ -11950,9 +11961,9 @@ export interface operations {
1195011961
'filters.repoSlug'?: string
1195111962
/** @description Comma-separated list of repo slugs that should be excluded */
1195211963
'filters.repoSlug.notIn'?: string
11953-
/** @description Comma-separated list of repo labels that should be included */
11964+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
1195411965
'filters.repoLabels'?: string
11955-
/** @description Comma-separated list of repo labels that should be excluded */
11966+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
1195611967
'filters.repoLabels.notIn'?: string
1195711968
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
1195811969
'filters.alertType'?: string
@@ -12047,7 +12058,7 @@ export interface operations {
1204712058
alertSeverity?: string[]
1204812059
/** @description Comma-separated list of repo slugs that should be excluded */
1204912060
repoSlug?: string[]
12050-
/** @description Comma-separated list of repo labels that should be excluded */
12061+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
1205112062
repoLabels?: string[]
1205212063
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
1205312064
alertType?: string[]
@@ -13113,6 +13124,7 @@ export interface operations {
1311313124
| 'typo'
1311413125
| 'secret'
1311513126
| 'obf'
13127+
| 'dual'
1311613128
/** @description Filter threats by package name */
1311713129
name?: string
1311813130
/** @description Filter threats by package version */
@@ -13215,6 +13227,7 @@ export interface operations {
1321513227
| 'typo'
1321613228
| 'secret'
1321713229
| 'obf'
13230+
| 'dual'
1321813231
/** @description Filter threats by package name */
1321913232
name?: string
1322013233
/** @description Filter threats by package version. */
@@ -13739,6 +13752,25 @@ export interface operations {
1373913752
429: components['responses']['SocketTooManyRequestsResponse']
1374013753
}
1374113754
}
13755+
/**
13756+
* Returns the OpenAPI definition
13757+
* @description Retrieve the API specification in an Openapi JSON format.
13758+
*
13759+
* This endpoint consumes 1 unit of your quota.
13760+
*
13761+
* This endpoint requires the following org token scopes:
13762+
*/
13763+
getOpenAPIJSON: {
13764+
responses: {
13765+
/** @description OpenAPI specification */
13766+
200: {
13767+
content: {
13768+
'application/json': unknown
13769+
}
13770+
}
13771+
429: components['responses']['SocketTooManyRequestsResponse']
13772+
}
13773+
}
1374213774
/**
1374313775
* Get quota
1374413776
* @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.

0 commit comments

Comments
 (0)