Skip to content

Commit 0ca5425

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

File tree

2 files changed

+32
-7
lines changed

2 files changed

+32
-7
lines changed

openapi.json

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10628,7 +10628,7 @@
1062810628
]
1062910629
}
1063010630
],
10631-
"description": "Batch retrieval of package metadata and alerts by PURL strings. Compatible witch CycloneDX reports.\n\nPackage URLs (PURLs) are an ecosystem agnostic way to identify packages.\nCycloneDX SBOMs use the purl format to identify components.\nThis endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.\n\nMore information on purl and CycloneDX:\n\n- [`purl` Spec](https://github.com/package-url/purl-spec)\n- [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)\n\nThis endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).\nActively running analysis will be returned when available on subsequent runs.\n\n## Examples:\n\n### Looking up an npm package:\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:npm/express@4.19.2\"\n }\n ]\n}\n```\n\n### Looking up an PyPi package:\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:pypi/django@5.0.6\"\n }\n ]\n}\n```\n\n### Looking up a Maven package:\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:maven/log4j/log4j@1.2.17\"\n }\n ]\n}\n```\n\n### Batch lookup\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:npm/express@4.19.2\"\n },\n {\n \"purl\": \"pkg:pypi/django@5.0.6\"\n },\n {\n \"purl\": \"pkg:maven/log4j/log4j@1.2.17\"\n }\n ]\n}\n```\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- packages:list",
10631+
"description": "Batch retrieval of package metadata and alerts by PURL strings. Compatible witch CycloneDX reports.\n\nPackage URLs (PURLs) are an ecosystem agnostic way to identify packages.\nCycloneDX SBOMs use the purl format to identify components.\nThis endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.\n\n**Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.\n\nMore information on purl and CycloneDX:\n\n- [`purl` Spec](https://github.com/package-url/purl-spec)\n- [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)\n\nThis endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).\nActively running analysis will be returned when available on subsequent runs.\n\n## Examples:\n\n### Looking up an npm package:\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:npm/express@4.19.2\"\n }\n ]\n}\n```\n\n### Looking up an PyPi package:\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:pypi/django@5.0.6\"\n }\n ]\n}\n```\n\n### Looking up a Maven package:\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:maven/log4j/log4j@1.2.17\"\n }\n ]\n}\n```\n\n### Batch lookup\n\n```json\n{\n \"components\": [\n {\n \"purl\": \"pkg:npm/express@4.19.2\"\n },\n {\n \"purl\": \"pkg:pypi/django@5.0.6\"\n },\n {\n \"purl\": \"pkg:maven/log4j/log4j@1.2.17\"\n }\n ]\n}\n```\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- packages:list",
1063210632
"responses": {
1063310633
"200": {
1063410634
"content": {
@@ -11414,7 +11414,8 @@
1141411414
"github",
1141511415
"gitlab",
1141611416
"bitbucket",
11417-
"azure"
11417+
"azure",
11418+
"web"
1141811419
]
1141911420
}
1142011421
},
@@ -12951,7 +12952,8 @@
1295112952
"github",
1295212953
"gitlab",
1295312954
"bitbucket",
12954-
"azure"
12955+
"azure",
12956+
"web"
1295512957
]
1295612958
}
1295712959
},
@@ -14722,7 +14724,8 @@
1472214724
"github",
1472314725
"gitlab",
1472414726
"bitbucket",
14725-
"azure"
14727+
"azure",
14728+
"web"
1472614729
]
1472714730
}
1472814731
},

types/api.d.ts

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ export interface paths {
1313
* CycloneDX SBOMs use the purl format to identify components.
1414
* This endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.
1515
*
16+
* **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
17+
*
1618
* More information on purl and CycloneDX:
1719
*
1820
* - [`purl` Spec](https://github.com/package-url/purl-spec)
@@ -4796,6 +4798,8 @@ export interface operations {
47964798
* CycloneDX SBOMs use the purl format to identify components.
47974799
* This endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.
47984800
*
4801+
* **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
4802+
*
47994803
* More information on purl and CycloneDX:
48004804
*
48014805
* - [`purl` Spec](https://github.com/package-url/purl-spec)
@@ -5168,7 +5172,13 @@ export interface operations {
51685172
/** @description The committers to associate with the full-scan. Set query more than once to set multiple. */
51695173
committers?: string
51705174
/** @description The integration type to associate the full-scan with. Defaults to "Api" if omitted. */
5171-
integration_type?: 'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure'
5175+
integration_type?:
5176+
| 'api'
5177+
| 'github'
5178+
| 'gitlab'
5179+
| 'bitbucket'
5180+
| 'azure'
5181+
| 'web'
51725182
/** @description The integration org slug to associate the full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges. */
51735183
integration_org_slug?: string
51745184
/** @description Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option. */
@@ -5705,7 +5715,13 @@ export interface operations {
57055715
/** @description The committers to associate with the full-scan. Set query more than once to set multiple. */
57065716
committers?: string
57075717
/** @description The integration type to associate the full-scan with. Defaults to "Api" if omitted. */
5708-
integration_type?: 'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure'
5718+
integration_type?:
5719+
| 'api'
5720+
| 'github'
5721+
| 'gitlab'
5722+
| 'bitbucket'
5723+
| 'azure'
5724+
| 'web'
57095725
/** @description The integration org slug to associate the full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges. */
57105726
integration_org_slug?: string
57115727
/** @description Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option. */
@@ -6314,7 +6330,13 @@ export interface operations {
63146330
/** @description The committers to associate the new full-scan with. Set query more than once to set multiple committers. */
63156331
committers?: string
63166332
/** @description The integration type to associate the new full-scan with. Defaults to "api" if omitted. */
6317-
integration_type?: 'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure'
6333+
integration_type?:
6334+
| 'api'
6335+
| 'github'
6336+
| 'gitlab'
6337+
| 'bitbucket'
6338+
| 'azure'
6339+
| 'web'
63186340
/** @description The integration org slug to associate the new full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges. */
63196341
integration_org_slug?: string
63206342
/** @description Set to true when running a diff between a merged commit and its parent commit in the same branch. Set to false when running diffs in an open PR between unmerged commits. */

0 commit comments

Comments
 (0)