DependencyTrack / DependencyTrack/frontend

Add a link to OpenAPI spec in UI

Open
#1,185 1 comment 0 reactions 0 assignees View on GitHub
enhancement good first issue p3 size/S
Dominant language
Vue
Stars
171
Forks
250
Avg merge
10h 56m
Merged PRs (30d)
84

Description

### Current Behavior

Finding the API spec requires googling and then finding out that the /api/swagger.json mentioned in places no longer exists and the 404 returned is not a deployment problem but a feature. The new endpoint is /api/openapi.json and /api/openapi.yaml.

### Proposed Behavior

add a link to the menu pointing to the API spec, for example like in Defect Dojo:

![Image](https://github.com/user-attachments/assets/00c38e48-f222-4ccf-b3be-8820d463b6fb)

might as well add a link to the docs there

### Checklist

- [x] I have read and understand the [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#filing-issues)
- [x] I have checked the [existing issues](https://github.com/DependencyTrack/frontend/issues) for whether this enhancement was already requested

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the frontend menu where navigation links are rendered and check how external or API links are presented. Add links to /api/openapi.json, /api/openapi.yaml, and the API documentation, then verify each link is visible in the menu and opens successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, frontend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.