starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-12 05:20:31 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

API Documentation is Missing dns_name__empty for /ipam/ip-addresses #7340

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

Originally created by @Spaceman1701 on GitHub (Dec 9, 2022).

NetBox version

v3.3.9

Python version

3.8

Steps to Reproduce

  1. view /ipam/ip-address in the swagger REST API docs and notice that dns_name__empty is listed as a parameter
  2. make an HTTP GET to /api/ipam/ip-addresses/?dns_name__empty=0 and /api/ipam/ip-addresses/?dns_name__emtpy=1 and observe that the query parameter has the desired effect

Expected Behavior

The /ipam/ip-addresses endpoint should list the dns_name__empty query parameter in the Swagger API Docs

Observed Behavior

The Swagger API docs are missing the dns_name__emtpy query parameter for GET /ipam/ip-addresses in the Swagger docs. The actual API still seems to honor this parameter. I've observed this in Netbox 3.3.9.

This is easy to observe on the demo instance:
https://demo.netbox.dev/api/ipam/ip-addresses/?dns_name__empty=1
https://demo.netbox.dev/api/ipam/ip-addresses/?dns_name__empty=0

Originally created by @Spaceman1701 on GitHub (Dec 9, 2022). ### NetBox version v3.3.9 ### Python version 3.8 ### Steps to Reproduce 1. view `/ipam/ip-address` in the swagger REST API docs and notice that `dns_name__empty` is listed as a parameter 2. make an HTTP GET to `/api/ipam/ip-addresses/?dns_name__empty=0` and `/api/ipam/ip-addresses/?dns_name__emtpy=1` and observe that the query parameter has the desired effect ### Expected Behavior The `/ipam/ip-addresses` endpoint should list the `dns_name__empty` query parameter in the Swagger API Docs ### Observed Behavior The Swagger API docs are missing the `dns_name__emtpy` query parameter for `GET /ipam/ip-addresses` in the Swagger docs. The actual API still seems to honor this parameter. I've observed this in Netbox 3.3.9. This is easy to observe on the demo instance: https://demo.netbox.dev/api/ipam/ip-addresses/?dns_name__empty=1 https://demo.netbox.dev/api/ipam/ip-addresses/?dns_name__empty=0
adam added the type: bugstatus: accepted labels 2025-12-29 20:22:06 +01:00
adam closed this issue 2025-12-29 20:22:06 +01:00
adam commented 2025-12-29 20:22:07 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Feb 12, 2023):

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. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Feb 12, 2023): 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. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:22:07 +01:00
Author
Owner
Copy Link

@fabi125 commented on GitHub (Feb 13, 2023):

We have some automation around the auto-generated api documentation and this is causing some issues for us. Could someone point me in the right direction on what might have caused this? I'm happy to take a stab at fixing it.

@fabi125 commented on GitHub (Feb 13, 2023): We have some automation around the auto-generated api documentation and this is causing some issues for us. Could someone point me in the right direction on what might have caused this? I'm happy to take a stab at fixing it.
adam commented 2025-12-29 20:22:07 +01:00
Author
Owner
Copy Link

@kkthxbye-code commented on GitHub (Feb 13, 2023):

I tested on v3.3.9 and v3.4.0 and this seems to have been fixed. In v3.3.9 dns_name__empty is missing and in v3.4.0+:

image.

@kkthxbye-code commented on GitHub (Feb 13, 2023): I tested on v3.3.9 and v3.4.0 and this seems to have been fixed. In v3.3.9 dns_name__empty is missing and in v3.4.0+: ![image](https://user-images.githubusercontent.com/400797/218498788-abb75b46-fa27-4ca6-8bd6-97b86c417aa2.png).
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 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#7340
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?