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

API Documentation Updates (Migrate from drf-yasg -> drf-spectacular) #6600

New Issue
Closed
opened 2025-12-29 19:42:50 +01:00 by adam · 4 comments
adam commented 2025-12-29 19:42:50 +01:00
Owner
Copy Link

Originally created by @huntabyte on GitHub (Jun 27, 2022).

Originally assigned to: @arthanson on GitHub.

Proposed Changes

I would like to work on updating the API documentation, however, the current package used to generate and manage the swagger docs lacks functionality, doesn't support OpenAPI 3.0, and isn't being actively maintained.

drf-spectacular is being actively maintained and provides some of the missing functionality.

I'd like to work on making this happen.

Justification

This would improve the developer's experience when building applications that interact with NetBox.

Originally created by @huntabyte on GitHub (Jun 27, 2022). Originally assigned to: @arthanson on GitHub. ### Proposed Changes I would like to work on updating the API documentation, however, the current package used to generate and manage the swagger docs lacks functionality, doesn't support OpenAPI 3.0, and isn't being actively maintained. [drf-spectacular ](https://github.com/tfranzel/drf-spectacular) is being actively maintained and provides some of the missing functionality. I'd like to work on making this happen. ### Justification This would improve the developer's experience when building applications that interact with NetBox.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 19:42:50 +01:00
adam closed this issue 2025-12-29 19:42:50 +01:00
adam commented 2025-12-29 19:42:50 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Sep 15, 2022):

@huntabyte are you still available and wanting to work on this?

@arthanson commented on GitHub (Sep 15, 2022): @huntabyte are you still available and wanting to work on this?
adam commented 2025-12-29 19:42:51 +01:00
Author
Owner
Copy Link

@huntabyte commented on GitHub (Sep 15, 2022):

@arthanson Yes, for sure.

@huntabyte commented on GitHub (Sep 15, 2022): @arthanson Yes, for sure.
adam commented 2025-12-29 19:42:51 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Sep 15, 2022):

@huntabyte That is great - thank you. Please go ahead and start working on this in a new branch. It will probably be tough to fit it into 3.4 release, probably would be 3.5 but we can see.

If possible, it probably makes sense to keep the current OpenAPI 2.0 drf-yasg in and have the drf-spectacular OpenAPI 3.0 in parallel, but I'm not sure if that is possible? If you need any help on it or questions, please let me know.

@arthanson commented on GitHub (Sep 15, 2022): @huntabyte That is great - thank you. Please go ahead and start working on this in a new branch. It will probably be tough to fit it into 3.4 release, probably would be 3.5 but we can see. If possible, it probably makes sense to keep the current OpenAPI 2.0 drf-yasg in and have the drf-spectacular OpenAPI 3.0 in parallel, but I'm not sure if that is possible? If you need any help on it or questions, please let me know.
adam commented 2025-12-29 19:42:51 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Oct 28, 2022):

@huntabyte any progress on this so far? I saw a couple other issues that OpenAPI 3 would be nice for.

@arthanson commented on GitHub (Oct 28, 2022): @huntabyte any progress on this so far? I saw a couple other issues that OpenAPI 3 would be nice for.
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: housekeeping
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#6600
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?