Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Swagger API doc has incorrect documentation for VRFRequest #16768

Closed
aaroneg opened this issue Jun 30, 2024 · 3 comments
Closed

Swagger API doc has incorrect documentation for VRFRequest #16768

aaroneg opened this issue Jun 30, 2024 · 3 comments
Labels
status: duplicate This issue has already been raised topic: OpenAPI type: bug A confirmed report of unexpected behavior in the application

Comments

@aaroneg
Copy link
Contributor

aaroneg commented 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.
@aaroneg aaroneg added status: needs triage This issue is awaiting triage by a maintainer type: bug A confirmed report of unexpected behavior in the application labels Jun 30, 2024
@jeffgdotorg
Copy link
Collaborator

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 jeffgdotorg removed their assignment Jul 1, 2024
@jeffgdotorg jeffgdotorg added status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation topic: OpenAPI severity: low Does not significantly disrupt application functionality, or a workaround is available and removed status: needs triage This issue is awaiting triage by a maintainer labels Jul 1, 2024
@aaroneg
Copy link
Contributor Author

aaroneg commented Jul 10, 2024

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

@arthanson
Copy link
Collaborator

arthanson commented Jul 12, 2024 •
edited
Loading

Closing this as duplicate of #16670

@jeremystretch jeremystretch added status: duplicate This issue has already been raised and removed status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation severity: low Does not significantly disrupt application functionality, or a workaround is available labels Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: duplicate This issue has already been raised topic: OpenAPI type: bug A confirmed report of unexpected behavior in the application
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@arthanson @jeffgdotorg @aaroneg @jeremystretch