Skip to content

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

Closed
@jeremystretch

Description

@jeremystretch

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

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions