Skip to content
Merged
Changes from all commits
Commits
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
76 changes: 68 additions & 8 deletions docs/reference/api/openapi-v1.yaml
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 @@ -1569,6 +1587,46 @@ paths:
summary: Updates an array of config properties
tags:
- configProperty
/v1/configProperty/internal/{groupName}/{propertyName}:
get:
description: |-
<p>
Requires authentication, but no permission.
Returns both internal and public properties
</p>
operationId: getInternalConfigProperty
parameters:
- description: The group name of the value to retrieve
in: path
name: groupName
required: true
schema:
type: string
- description: The property name of the value to retrieve
in: path
name: propertyName
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigPropertyResponse"
description: The internal config property
"401":
description: Unauthorized
"403":
description: Not an internal- or public-readable config property
"404":
description: The config property could not be found
security:
- ApiKeyAuth: []
- BearerAuth: []
summary: Returns an internal ConfigProperty
tags:
- configProperty
/v1/configProperty/public/{groupName}/{propertyName}:
get:
description: <p></p>
Expand Down Expand Up @@ -9681,6 +9739,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 +11012,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 +11301,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 +11558,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