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

API docs should display default values #3553

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

Originally created by @mf69 on GitHub (Apr 8, 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 default values for parameters in the API docs /api/docs

For instance the value of the limit parameter for /ipam/ip-addresses GET is apparently 50

If I had seen that it defaulted so low I'd have a hint to set it higher. Instead I only discover later we're getting a limited result.

Originally created by @mf69 on GitHub (Apr 8, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. Please indicate the nature of the change by placing an X in one of the boxes below. --> ### 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 default values for parameters in the API docs /api/docs For instance the value of the _limit_ parameter for /ipam/ip-addresses GET is apparently 50 If I had seen that it defaulted so low I'd have a hint to set it higher. Instead I only discover later we're getting a limited result.
adam closed this issue 2025-12-29 18:29:51 +01:00
adam commented 2025-12-29 18:29:51 +01:00
Author
Owner
Copy Link

@kobayashi commented on GitHub (Apr 9, 2020):

Thanks to open this issue. The default set is described in here.

@kobayashi commented on GitHub (Apr 9, 2020): Thanks to open this issue. The default set is described in [here](https://netbox.readthedocs.io/en/stable/api/overview/#pagination).
adam commented 2025-12-29 18:29:51 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 9, 2020):

Add the default values for parameters in the API docs /api/docs

Please elaborate on your proposed change. What does the proposed Swagger output look like compared to its current form?

@jeremystretch commented on GitHub (Apr 9, 2020): > Add the default values for parameters in the API docs /api/docs Please elaborate on your proposed change. What does the proposed Swagger output look like compared to its current form?
adam commented 2025-12-29 18:29:52 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 20, 2020):

Closing due to lack of activity.

@jeremystretch commented on GitHub (Apr 20, 2020): Closing due to lack of activity.
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
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#3553
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?