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

Add a url field to all REST API serializers #3821

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

Originally created by @jeremystretch on GitHub (Jun 30, 2020).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Currently, all nested serializers include a url attribute containing a link to their corresponding detail view. For example, when viewing the assigned site of a device, the site representation includes a url indicating where to retrieve the full site representation via the REST API. This issue proposes extending this field to the full object serializers as well.

Justification

  1. Ensures that url is consistently available on all serialized representations.
  2. Allows directly referencing a specific object's location from within a list view without requiring the client to calculate the URL.

This may be a bit redundant when viewing single objects, however there's still an argument to be made for the utility of easily replicating the current request by simply referencing the url field.

Originally created by @jeremystretch on GitHub (Jun 30, 2020). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Currently, all nested serializers include a `url` attribute containing a link to their corresponding detail view. For example, when viewing the assigned site of a device, the `site` representation includes a `url` indicating where to retrieve the full site representation via the REST API. This issue proposes extending this field to the full object serializers as well. ### Justification 1. Ensures that `url` is consistently available on all serialized representations. 2. Allows directly referencing a specific object's location from within a list view without requiring the client to calculate the URL. This may be a bit redundant when viewing single objects, however there's still an argument to be made for the utility of easily replicating the current request by simply referencing the `url` field.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 18:31:22 +01:00
adam closed this issue 2025-12-29 18:31:22 +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#3821
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?