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

Update API viewset descriptions #7890

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

Originally created by @abhi1693 on GitHub (Apr 10, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.5-beta1

Feature type

Change to existing functionality

Proposed functionality

Override the get_description in NetBoxAutoSchema to display relevant description for the ViewSet.

Example:

GET /api/dcim/devices/

Get a list of Device objects.

Use case

The change will more accurately define the intent of the method. This also helps in write better documentation in generated client libraries.

Database changes

No response

External dependencies

No response

Originally created by @abhi1693 on GitHub (Apr 10, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.5-beta1 ### Feature type Change to existing functionality ### Proposed functionality Override the `get_description` in `NetBoxAutoSchema` to display relevant description for the ViewSet. Example: ``` GET /api/dcim/devices/ Get a list of Device objects. ``` ### Use case The change will more accurately define the intent of the method. This also helps in write better documentation in generated client libraries. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featuretopic: OpenAPI labels 2025-12-29 20:29:35 +01:00
adam closed this issue 2025-12-29 20:29: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 topic: OpenAPI 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#7890
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?