Skip to content
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

Jump to bottom

Add a link to OpenAPI spec in UI #1185

Open
2 tasks done
valentijnscholten opened this issue Mar 3, 2025 · 0 comments
Open
2 tasks done

Add a link to OpenAPI spec in UI #1185

valentijnscholten opened this issue Mar 3, 2025 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers p3 Nice-to-have features size/S Small effort

Comments

@valentijnscholten
Copy link
Contributor

valentijnscholten commented Mar 3, 2025 •
edited
Loading

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

might as well add a link to the docs there

Checklist
@valentijnscholten valentijnscholten added the enhancement New feature or request label Mar 3, 2025
@nscuro nscuro added p3 Nice-to-have features good first issue Good for newcomers size/S Small effort labels Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers p3 Nice-to-have features size/S Small effort
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@valentijnscholten @nscuro