Skip to content

Sync with OpenAPI definition #449

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

Merged
alxhotel merged 1 commit into from
Dec 5, 2025
Merged

Sync with OpenAPI definition #449

Show file tree
Hide file tree
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
11 changes: 7 additions & 4 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10628,7 +10628,7 @@
]
}
],
"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",
"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",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -11414,7 +11414,8 @@
"github",
"gitlab",
"bitbucket",
"azure"
"azure",
"web"
]
}
},
Expand Down Expand Up @@ -12951,7 +12952,8 @@
"github",
"gitlab",
"bitbucket",
"azure"
"azure",
"web"
]
}
},
Expand Down Expand Up @@ -14722,7 +14724,8 @@
"github",
"gitlab",
"bitbucket",
"azure"
"azure",
"web"
]
}
},
Expand Down
28 changes: 25 additions & 3 deletions types/api.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ export interface paths {
* CycloneDX SBOMs use the purl format to identify components.
* 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.
*
* **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
*
* More information on purl and CycloneDX:
*
* - [`purl` Spec](https://github.com/package-url/purl-spec)
Expand Down Expand Up @@ -4796,6 +4798,8 @@ export interface operations {
* CycloneDX SBOMs use the purl format to identify components.
* 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.
*
* **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
*
* More information on purl and CycloneDX:
*
* - [`purl` Spec](https://github.com/package-url/purl-spec)
Expand Down Expand Up @@ -5168,7 +5172,13 @@ export interface operations {
/** @description The committers to associate with the full-scan. Set query more than once to set multiple. */
committers?: string
/** @description The integration type to associate the full-scan with. Defaults to "Api" if omitted. */
integration_type?: 'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure'
integration_type?:
| 'api'
| 'github'
| 'gitlab'
| 'bitbucket'
| 'azure'
| 'web'
/** @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. */
integration_org_slug?: string
/** @description Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option. */
Expand Down Expand Up @@ -5705,7 +5715,13 @@ export interface operations {
/** @description The committers to associate with the full-scan. Set query more than once to set multiple. */
committers?: string
/** @description The integration type to associate the full-scan with. Defaults to "Api" if omitted. */
integration_type?: 'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure'
integration_type?:
| 'api'
| 'github'
| 'gitlab'
| 'bitbucket'
| 'azure'
| 'web'
/** @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. */
integration_org_slug?: string
/** @description Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option. */
Expand Down Expand Up @@ -6314,7 +6330,13 @@ export interface operations {
/** @description The committers to associate the new full-scan with. Set query more than once to set multiple committers. */
committers?: string
/** @description The integration type to associate the new full-scan with. Defaults to "api" if omitted. */
integration_type?: 'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure'
integration_type?:
| 'api'
| 'github'
| 'gitlab'
| 'bitbucket'
| 'azure'
| 'web'
/** @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. */
integration_org_slug?: string
/** @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. */
Expand Down