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

Include the description field in "brief" REST API serializations #9285

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

Originally created by @jeremystretch on GitHub (Feb 23, 2024).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.7.3

Feature type

New functionality

Proposed functionality

Currently, "brief" mode REST API responses do not include an object's description:

# GET /api/dcim/sites/1/?brief=true
{
    "id": 1,
    "url": "http://netbox:8000/api/dcim/sites/1/",
    "display": "DM-NYC",
    "name": "DM-NYC",
    "slug": "dm-nyc"
}

This proposal is to include the description field in this output, where applicable.

Use case

Following #13283, the description field can be included on dynamically-populated dropdown fields to convey additional context about each object. It is also likely useful in many other scenarios, and its inclusion imposes no significant performance penalty.

Database changes

None

External dependencies

None

Originally created by @jeremystretch on GitHub (Feb 23, 2024). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.7.3 ### Feature type New functionality ### Proposed functionality Currently, "brief" mode REST API responses do not include an object's description: ``` # GET /api/dcim/sites/1/?brief=true { "id": 1, "url": "http://netbox:8000/api/dcim/sites/1/", "display": "DM-NYC", "name": "DM-NYC", "slug": "dm-nyc" } ``` This proposal is to include the `description` field in this output, where applicable. ### Use case Following #13283, the description field can be included on dynamically-populated dropdown fields to convey additional context about each object. It is also likely useful in many other scenarios, and its inclusion imposes no significant performance penalty. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 20:47:50 +01:00
adam closed this issue 2025-12-29 20:47:50 +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: feature
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#9285
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?