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 'brief' and 'exclude' to Swagger Documentation #3469

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

Originally created by @dstarner on GitHub (Mar 12, 2020).

Change Type

[X] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Area

[ ] Installation instructions
[ ] Configuration parameters
[ ] Functionality/features
[X] REST API
[ ] Administration/development
[ ] Other

Proposed Changes

Add the brief and exclude parameters to the Swagger API for appropriate routes such as list devices and get device so that they can be used by Swagger clients. They should be included in the same manner that the q parameter is.

Originally created by @dstarner on GitHub (Mar 12, 2020). ### Change Type [X] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) ### Area [ ] Installation instructions [ ] Configuration parameters [ ] Functionality/features [X] REST API [ ] Administration/development [ ] Other <!-- Describe the proposed change(s). --> ### Proposed Changes Add the `brief` and `exclude` parameters to the Swagger API for appropriate routes such as list devices and get device so that they can be used by Swagger clients. They should be included in the same manner that the `q` parameter is.
adam added the pending closure label 2025-12-29 18:29:23 +01:00
adam closed this issue 2025-12-29 18:29:23 +01:00
adam commented 2025-12-29 18:29:23 +01:00
Author
Owner
Copy Link

@kobayashi commented on GitHub (Mar 16, 2020):

Is this the same as #4357?

@kobayashi commented on GitHub (Mar 16, 2020): Is this the same as #4357?
adam commented 2025-12-29 18:29:23 +01:00
Author
Owner
Copy Link

@dstarner commented on GitHub (Mar 16, 2020):

No, this is to add documentation on it, since neither variables are present in the Swagger documentation

@dstarner commented on GitHub (Mar 16, 2020): No, this is to add documentation on it, since neither variables are present in the Swagger documentation
adam commented 2025-12-29 18:29:23 +01:00
Author
Owner
Copy Link

@dstarner commented on GitHub (Mar 17, 2020):

@kobayashi / @jeremystretch is this something that can be approved so that I can create a PR for it?

@dstarner commented on GitHub (Mar 17, 2020): @kobayashi / @jeremystretch is this something that can be approved so that I can create a PR for it?
adam commented 2025-12-29 18:29:24 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Mar 31, 2020):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@stale[bot] commented on GitHub (Mar 31, 2020): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 18:29:24 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Apr 8, 2020):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@stale[bot] commented on GitHub (Apr 8, 2020): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 pending closure
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#3469
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?