Skip to content

Update OpenAPI docs #166

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −8
Open

Update OpenAPI docs #166

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
36 changes: 28 additions & 8 deletions docs/reference/api/openapi-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,14 @@ paths:
a response with problem details in RFC 9457 format will be returned. In this case,
the response's content type will be <code>application/problem+json</code>.
</p>
<p>
When creating projects, <code>parentUUID</code> or <code>parentName</code> and
<code>parentVersion</code> can place the new project under a parent,
<code>projectTags</code> can apply tags, and <code>isLatest</code> can mark it as
the latest version. The <code>isActive</code> parameter sets the project's active
state whenever it is provided, including when the target project already exists, so
clients should send it only when they intend to change that state.
</p>
<p>Requires permission <strong>BOM_UPLOAD</strong></p>
operationId: UploadBom
requestBody:
Expand All @@ -483,6 +491,8 @@ paths:
default: false
bom:
type: string
isActive:
type: boolean
isLatest:
type: boolean
default: false
Expand Down Expand Up @@ -540,6 +550,14 @@ paths:
a response with problem details in RFC 9457 format will be returned. In this case,
the response's content type will be <code>application/problem+json</code>.
</p>
<p>
When creating projects, <code>parentUUID</code> or <code>parentName</code> and
<code>parentVersion</code> can place the new project under a parent,
<code>projectTags</code> can apply tags, and <code>isLatest</code> can mark it as
the latest version. The <code>isActive</code> parameter sets the project's active
state whenever it is provided, including when the target project already exists, so
clients should send it only when they intend to change that state.
</p>
<p>
The maximum allowed length of the <code>bom</code> value is 20'000'000 characters.
When uploading large BOMs, the <code>POST</code> endpoint is preferred,
Expand Down Expand Up @@ -9681,6 +9699,8 @@ components:
description: Base64 encoded BOM
example: ewogICJib21Gb3JtYXQiOiAiQ3ljbG9uZURYIiwKICAic3BlY1ZlcnNpb24iOiAiMS40IiwKICAiY29tcG9uZW50cyI6IFsKICAgIHsKICAgICAgInR5cGUiOiAibGlicmFyeSIsCiAgICAgICJuYW1lIjogImFjbWUtbGliIiwKICAgICAgInZlcnNpb24iOiAiMS4wLjAiCiAgICB9CiAgXQp9
pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
isActive:
type: boolean
isLatest:
type: boolean
parentName:
Expand Down Expand Up @@ -10952,6 +10972,10 @@ components:
maxLength: 255
minLength: 0
pattern: "[\\P{Cc}]+"
permissions:
type: array
items:
$ref: "#/components/schemas/Permission"
username:
type: string
maxLength: 255
Expand Down Expand Up @@ -11237,6 +11261,10 @@ components:
$ref: "#/components/schemas/Permission"
suspended:
type: boolean
teams:
type: array
items:
$ref: "#/components/schemas/Team"
username:
type: string
maxLength: 255
Expand Down Expand Up @@ -11490,19 +11518,11 @@ components:
maxLength: 255
minLength: 0
pattern: "[\\P{Cc}]+"
permissions:
type: array
items:
$ref: "#/components/schemas/Permission"
subjectIdentifier:
type: string
maxLength: 255
minLength: 1
pattern: "[\\P{Cc}]+"
teams:
type: array
items:
$ref: "#/components/schemas/Team"
username:
type: string
maxLength: 255
Expand Down