From 8dc8cdd9df75e170c0912c8293775fae774cbe4d Mon Sep 17 00:00:00 2001 From: dependencytrack-bot <106437498+dependencytrack-bot@users.noreply.github.com> Date: Wed, 24 Jun 2026 16:26:28 +0000 Subject: [PATCH] Update OpenAPI docs Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/reference/api/openapi-v1.yaml | 76 ++++++++++++++++++++++++++---- 1 file changed, 68 insertions(+), 8 deletions(-) diff --git a/docs/reference/api/openapi-v1.yaml b/docs/reference/api/openapi-v1.yaml index 6550288..ab7801f 100644 --- a/docs/reference/api/openapi-v1.yaml +++ b/docs/reference/api/openapi-v1.yaml @@ -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 application/problem+json.

+

+ When creating projects, parentUUID or parentName and + parentVersion can place the new project under a parent, + projectTags can apply tags, and isLatest can mark it as + the latest version. The isActive 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. +

Requires permission BOM_UPLOAD

operationId: UploadBom requestBody: @@ -483,6 +491,8 @@ paths: default: false bom: type: string + isActive: + type: boolean isLatest: type: boolean default: false @@ -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 application/problem+json.

+

+ When creating projects, parentUUID or parentName and + parentVersion can place the new project under a parent, + projectTags can apply tags, and isLatest can mark it as + the latest version. The isActive 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. +

The maximum allowed length of the bom value is 20'000'000 characters. When uploading large BOMs, the POST endpoint is preferred, @@ -1569,6 +1587,46 @@ paths: summary: Updates an array of config properties tags: - configProperty + /v1/configProperty/internal/{groupName}/{propertyName}: + get: + description: |- +

+ Requires authentication, but no permission. + Returns both internal and public properties +

+ 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:

@@ -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: @@ -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 @@ -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 @@ -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