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

Refactor NetBoxModelViewSet to allow the creation of read-only API endpoints #7574

New Issue
Closed
opened 2025-12-29 20:25:35 +01:00 by adam · 0 comments
adam commented 2025-12-29 20:25:35 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jan 27, 2023).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Break out the methods of NetBoxModelViewSet which are not specific to write requests into a separate mixin or set of mixins. This should be done in a manner that backward compatibility for existing plugins is fully retained.

Justification

The NetBoxModelViewSet class is currently written with the assumption that all REST API endpoints will support the full suite of CRUDL functionality. However, in some cases it may be desirable to employ read-only endpoints which still leverage custom NetBox functionality, such as export template support. A recent example of this is FR #11558, which introduces a DataFile model that should not be mutable via the REST API, however it's likely we'll encounter similar requirements in the future.

Originally created by @jeremystretch on GitHub (Jan 27, 2023). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Break out the methods of `NetBoxModelViewSet` which are not specific to write requests into a separate mixin or set of mixins. This should be done in a manner that backward compatibility for existing plugins is fully retained. ### Justification The `NetBoxModelViewSet` class is currently written with the assumption that all REST API endpoints will support the full suite of CRUDL functionality. However, in some cases it may be desirable to employ read-only endpoints which still leverage custom NetBox functionality, such as export template support. A recent example of this is FR #11558, which introduces a `DataFile` model that should not be mutable via the REST API, however it's likely we'll encounter similar requirements in the future.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 20:25:35 +01:00
adam closed this issue 2025-12-29 20:25:35 +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: 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#7574
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?