starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-12 05:20:31 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add note about the /api/docs swagger page to the API overview docs #2817

New Issue
Closed
opened 2025-12-29 18:22:26 +01:00 by adam · 0 comments
adam commented 2025-12-29 18:22:26 +01:00
Owner
Copy Link

Originally created by @lampwins on GitHub (Aug 20, 2019).

Change Type

[ x ] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Proposed Changes

I have discovered from a handful of users that the NetBox Swagger page is an unintended best-kept secret. While there is a link to it on the bottom right of each NetBox UI page, we have no mention of it in the API section of the documentation, as these users have pointed out.

Originally created by @lampwins on GitHub (Aug 20, 2019). <!-- Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [ x ] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) <!-- Describe the proposed change(s). --> ### Proposed Changes I have discovered from a handful of users that the NetBox Swagger page is an unintended best-kept secret. While there is a link to it on the bottom right of each NetBox UI page, we have no mention of it in the API section of the documentation, as these users have pointed out.
adam added the status: acceptedtype: documentation labels 2025-12-29 18:22:26 +01:00
adam closed this issue 2025-12-29 18:22:26 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2817
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?