Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
jeremystretch opened this issue Feb 23, 2024 · 0 comments
Closed

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

jeremystretch opened this issue Feb 23, 2024 · 0 comments
Assignees
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone

Comments

@jeremystretch
Copy link
Member

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

@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application labels Feb 23, 2024
@jeremystretch jeremystretch added this to the v4.0 milestone Feb 23, 2024
@jeremystretch jeremystretch self-assigned this Feb 23, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

1 participant