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

Available IP OpenAPI schema incorrect #2747

New Issue
Closed
opened 2025-12-29 18:21:43 +01:00 by adam · 1 comment
adam commented 2025-12-29 18:21:43 +01:00
Owner
Copy Link

Originally created by @Marlinc on GitHub (Jul 20, 2019).

Originally assigned to: @jeremystretch on GitHub.

Environment

  • Python version: 3.6.7
  • NetBox version: 2.6.1

Steps to Reproduce

  1. Go to /api/docs/, scroll to /api/ipam/prefixes/{id}/available-ips/ and see the response being defined as a prefix model instead of a list of IP addresses

Expected Behavior

I expected the right documentation to be set in the OpenAPI schema so that my generated API client would work. Now it gives errors because it expects a prefix but is getting a list of IPs instead.

The same also applies to the POST call.

Observed Behavior

I'd expect the OpenAPI schema to be as follows:

[
  {
    "family": 6,
    "address": "some-ip/64",
    "vrf": null
  },
  {
    "family": 6,
    "address": "some-ip/64",
    "vrf": null
  }
]

Which is what NetBox is actually returning.

Originally created by @Marlinc on GitHub (Jul 20, 2019). Originally assigned to: @jeremystretch on GitHub. <!-- NOTE: This form is only for reproducible bugs. If you need assistance with NetBox installation, or if you have a general question, DO NOT open an issue. Instead, post to our mailing list: https://groups.google.com/forum/#!forum/netbox-discuss Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.6.7 * NetBox version: 2.6.1 <!-- Describe in detail the exact steps that someone else can take to reproduce this bug using the current stable release of NetBox (or the current beta release where applicable). Begin with the creation of any necessary database objects and call out every operation being performed explicitly. If reporting a bug in the REST API, be sure to reconstruct the raw HTTP request(s) being made: Don't rely on a wrapper like pynetbox. --> ### Steps to Reproduce 1. Go to `/api/docs/`, scroll to `/api/ipam/prefixes/{id}/available-ips/` and see the response being defined as a prefix model instead of a list of IP addresses <!-- What did you expect to happen? --> ### Expected Behavior I expected the right documentation to be set in the OpenAPI schema so that my generated API client would work. Now it gives errors because it expects a prefix but is getting a list of IPs instead. The same also applies to the POST call. <!-- What happened instead? --> ### Observed Behavior I'd expect the OpenAPI schema to be as follows: ``` [ { "family": 6, "address": "some-ip/64", "vrf": null }, { "family": 6, "address": "some-ip/64", "vrf": null } ] ``` Which is what NetBox is actually returning.
adam added the type: bugstatus: accepted labels 2025-12-29 18:21:43 +01:00
adam closed this issue 2025-12-29 18:21:43 +01:00
adam commented 2025-12-29 18:21:44 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 9, 2019):

Related to #2769

@jeremystretch commented on GitHub (Dec 9, 2019): Related to #2769
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#2747
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?