Skip to content

Update OpenAPI docs #20

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
nscuro merged 1 commit into from
Apr 25, 2026
Merged

Update OpenAPI docs #20

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
18 changes: 16 additions & 2 deletions docs/reference/api/openapi-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,18 @@ info:
contact:
name: The Dependency-Track Authors
url: https://github.com/DependencyTrack/dependency-track
description: REST API of OWASP Dependency-Track
description: |-
REST API of OWASP Dependency-Track

## Deprecations

Operations may be removed or replaced over time. When a response
carries the `X-API-Deprecated: true` header, the operation that
produced it is deprecated and may be removed in a future release.
Clients should check for this header on every response and surface
it (e.g. via a log warning) so that operators are aware of
upcoming breakages. The respective operation's description points
out which alternative operation(s) to use.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down Expand Up @@ -8684,7 +8695,10 @@ paths:
- vulnerability
/v1/vulnerability/project/{uuid}:
get:
description: <p>Requires permission <strong>VIEW_PORTFOLIO</strong></p>
deprecated: true
description: |-
<p>Requires permission <strong>VIEW_PORTFOLIO</strong></p>
<p><strong>Deprecated</strong>! Use <code>/api/v1/finding/project/{uuid}</code> instead.</p>
operationId: getVulnerabilitiesByProject
parameters:
- description: The UUID of the project to retrieve vulnerabilities for
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/api/openapi-v2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,16 @@ info:
created resource.

Delete operations return `204 No Content` with no body.

## Deprecations

Operations may be removed or replaced over time. When a response
carries the `X-API-Deprecated: true` header, the operation that
produced it is deprecated and may be removed in a future release.
Clients should check for this header on every response and surface
it (e.g. via a log warning) so that operators are aware of upcoming
breakages. The respective operation's description points out which
alternative operation(s) to use.
contact:
name: The Dependency-Track Authors
url: https://github.com/DependencyTrack/dependency-track
Expand Down