starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-13 22:03:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Swagger API doc has incorrect documentation for VRFRequest #9921

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

Originally created by @aaroneg on GitHub (Jun 30, 2024).

Deployment Type

Self-hosted

NetBox Version

v4.0.6

Python Version

3.10

Steps to Reproduce

Review the "New VRF" screen in netbox, and compare to https://$hostname/api/schema/swagger-ui/#/ipam/ipam_vrfs_create .
Very few fields are listed in the schema for VRFRequest, and more fields are accepted by the API. The PatchedVRFRequest schema item looks more accurate.

Expected Behavior

The documentation lists all available fields for the type of object

Observed Behavior

The documentation is missing many fields.

Originally created by @aaroneg on GitHub (Jun 30, 2024). ### Deployment Type Self-hosted ### NetBox Version v4.0.6 ### Python Version 3.10 ### Steps to Reproduce Review the "New VRF" screen in netbox, and compare to https://$hostname/api/schema/swagger-ui/#/ipam/ipam_vrfs_create . Very few fields are listed in the schema for `VRFRequest`, and more fields are accepted by the API. The `PatchedVRFRequest` schema item looks more accurate. ### Expected Behavior The documentation lists all available fields for the type of object ### Observed Behavior The documentation is missing many fields.
adam added the type: bugstatus: duplicatetopic: OpenAPI labels 2025-12-29 21:24:24 +01:00
adam closed this issue 2025-12-29 21:24:24 +01:00
adam commented 2025-12-29 21:24:25 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Jul 1, 2024):

Thank you for reporting this problem in NetBox. I was able to reproduce it in a fresh installation of v4.0.6. I'm moving your issue along to needs owner status.

We're generally aware that there are gaps in our OpenAPI coverage, but currently lack the team capacity to prioritize an effort to address these kinds of problems. If you or another developer with the requisite skills and capacity would like to work it through to a PR, please say so and a maintainer will assign the issue to you.

(Apologies for the copypasta of my reply on #16765)

@jeffgdotorg commented on GitHub (Jul 1, 2024): Thank you for reporting this problem in NetBox. I was able to reproduce it in a fresh installation of v4.0.6. I'm moving your issue along to `needs owner` status. We're generally aware that there are gaps in our OpenAPI coverage, but currently lack the team capacity to prioritize an effort to address these kinds of problems. If you or another developer with the requisite skills and capacity would like to work it through to a PR, please say so and a maintainer will assign the issue to you. (Apologies for the copypasta of my reply on #16765)
adam commented 2025-12-29 21:24:26 +01:00
Author
Owner
Copy Link

@aaroneg commented on GitHub (Jul 10, 2024):

No need for apologies, opening the second issue it started to feel like i might be accidentally spamming.

@aaroneg commented on GitHub (Jul 10, 2024): No need for apologies, opening the second issue it started to feel like i might be accidentally spamming.
adam commented 2025-12-29 21:24:26 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jul 12, 2024):

Closing this as duplicate of #16670

@arthanson commented on GitHub (Jul 12, 2024): Closing this as duplicate of #16670
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: duplicate topic: OpenAPI type: bug
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#9921
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?