Skip to content

Commit

Permalink
chore: regenerate api spec
Browse files Browse the repository at this point in the history
  • Loading branch information
ctron committed Jan 21, 2025
1 parent 7d39379 commit 31acd1f
Showing 1 changed file with 169 additions and 80 deletions.
249 changes: 169 additions & 80 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,25 @@ paths:
description: The tool request was invalid
'404':
description: The tool was not found
/api/v2/analysis/component/{key}:
get:
tags:
- analysis
operationId: getComponent
parameters:
- name: key
in: path
description: provide component name, URL-encoded pURL, or CPE itself
required: true
schema:
type: string
responses:
'200':
description: Retrieve component(s) root components by name, pURL, or CPE.
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResults_BaseSummary'
/api/v2/analysis/dep:
get:
tags:
Expand Down Expand Up @@ -503,7 +522,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/DepSummary'
$ref: '#/components/schemas/PaginatedResults_DepSummary'
/api/v2/analysis/dep/{key}:
get:
tags:
Expand All @@ -522,7 +541,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/DepSummary'
$ref: '#/components/schemas/PaginatedResults_DepSummary'
/api/v2/analysis/root-component:
get:
tags:
Expand Down Expand Up @@ -567,7 +586,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/AncestorSummary'
$ref: '#/components/schemas/PaginatedResults_AncestorSummary'
/api/v2/analysis/root-component/{key}:
get:
tags:
Expand All @@ -576,17 +595,17 @@ paths:
parameters:
- name: key
in: path
description: provide component name or URL-encoded pURL itself
description: provide component name, URL-encoded pURL, or CPE itself
required: true
schema:
type: string
responses:
'200':
description: Retrieve component(s) root components by name or pURL.
description: Retrieve component(s) root components by name, pURL, or CPE.
content:
application/json:
schema:
$ref: '#/components/schemas/AncestorSummary'
$ref: '#/components/schemas/PaginatedResults_AncestorSummary'
/api/v2/analysis/status:
get:
tags:
Expand Down Expand Up @@ -2413,6 +2432,44 @@ components:
version:
type: string
AncestorSummary:
allOf:
- $ref: '#/components/schemas/BaseSummary'
- type: object
required:
- ancestors
properties:
ancestors:
type: array
items:
$ref: '#/components/schemas/AncNode'
BasePurlDetails:
allOf:
- $ref: '#/components/schemas/BasePurlHead'
- type: object
required:
- versions
properties:
versions:
type: array
items:
$ref: '#/components/schemas/VersionedPurlSummary'
BasePurlHead:
type: object
required:
- uuid
- purl
properties:
purl:
$ref: '#/components/schemas/Purl'
description: The actual base PURL
uuid:
type: string
format: uuid
description: The ID of the base PURL
BasePurlSummary:
allOf:
- $ref: '#/components/schemas/BasePurlHead'
BaseSummary:
type: object
required:
- sbom_id
Expand All @@ -2425,12 +2482,7 @@ components:
- document_id
- product_name
- product_version
- ancestors
properties:
ancestors:
type: array
items:
$ref: '#/components/schemas/AncNode'
cpe:
type: array
items:
Expand All @@ -2455,33 +2507,6 @@ components:
type: string
version:
type: string
BasePurlDetails:
allOf:
- $ref: '#/components/schemas/BasePurlHead'
- type: object
required:
- versions
properties:
versions:
type: array
items:
$ref: '#/components/schemas/VersionedPurlSummary'
BasePurlHead:
type: object
required:
- uuid
- purl
properties:
purl:
$ref: '#/components/schemas/Purl'
description: The actual base PURL
uuid:
type: string
format: uuid
description: The ID of the base PURL
BasePurlSummary:
allOf:
- $ref: '#/components/schemas/BasePurlHead'
BinaryByteSize:
type: string
ChatMessage:
Expand Down Expand Up @@ -2691,48 +2716,16 @@ components:
version:
type: string
DepSummary:
type: object
required:
- sbom_id
- node_id
- purl
- cpe
- name
- version
- published
- document_id
- product_name
- product_version
- deps
properties:
cpe:
type: array
items:
$ref: '#/components/schemas/Cpe'
deps:
type: array
items:
$ref: '#/components/schemas/DepNode'
document_id:
type: string
name:
type: string
node_id:
type: string
product_name:
type: string
product_version:
type: string
published:
type: string
purl:
type: array
items:
$ref: '#/components/schemas/Purl'
sbom_id:
type: string
version:
type: string
allOf:
- $ref: '#/components/schemas/BaseSummary'
- type: object
required:
- deps
properties:
deps:
type: array
items:
$ref: '#/components/schemas/DepNode'
ExternalReferenceQuery:
type: object
properties:
Expand Down Expand Up @@ -3052,6 +3045,29 @@ components:
type: integer
format: int64
minimum: 0
PaginatedResults_AncestorSummary:
type: object
required:
- items
- total
properties:
items:
type: array
items:
allOf:
- $ref: '#/components/schemas/BaseSummary'
- type: object
required:
- ancestors
properties:
ancestors:
type: array
items:
$ref: '#/components/schemas/AncNode'
total:
type: integer
format: int64
minimum: 0
PaginatedResults_BasePurlSummary:
type: object
required:
Expand All @@ -3067,6 +3083,56 @@ components:
type: integer
format: int64
minimum: 0
PaginatedResults_BaseSummary:
type: object
required:
- items
- total
properties:
items:
type: array
items:
type: object
required:
- sbom_id
- node_id
- purl
- cpe
- name
- version
- published
- document_id
- product_name
- product_version
properties:
cpe:
type: array
items:
$ref: '#/components/schemas/Cpe'
document_id:
type: string
name:
type: string
node_id:
type: string
product_name:
type: string
product_version:
type: string
published:
type: string
purl:
type: array
items:
$ref: '#/components/schemas/Purl'
sbom_id:
type: string
version:
type: string
total:
type: integer
format: int64
minimum: 0
PaginatedResults_ConversationSummary:
type: object
required:
Expand Down Expand Up @@ -3094,6 +3160,29 @@ components:
type: integer
format: int64
minimum: 0
PaginatedResults_DepSummary:
type: object
required:
- items
- total
properties:
items:
type: array
items:
allOf:
- $ref: '#/components/schemas/BaseSummary'
- type: object
required:
- deps
properties:
deps:
type: array
items:
$ref: '#/components/schemas/DepNode'
total:
type: integer
format: int64
minimum: 0
PaginatedResults_ImporterReport:
type: object
required:
Expand Down

0 comments on commit 31acd1f

Please sign in to comment.