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 provide more examples #5386

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

Originally created by @georgesnow on GitHub (Sep 17, 2021).

Change Type

Addition

Area

REST API

Proposed Changes

I have been attempting to try and use the api via python. And I am finding difficult to find some more specific and clear examples.

Currently, I am attempting to assign an IP to an interface. However, I am having to look through each object to find the proper method call and value. I had attempted to gleam some insight via CSV import but those fields don’t match all the methods.
I reviewed one of the other open tickets, but I still wasn’t able to track down the proper way to do it.

I would propose the documentation show simple call to add each of the various attributes. I am willing to contribute examples once I figure them out as well.

Originally created by @georgesnow on GitHub (Sep 17, 2021). ### Change Type Addition ### Area REST API ### Proposed Changes I have been attempting to try and use the api via python. And I am finding difficult to find some more specific and clear examples. Currently, I am attempting to assign an IP to an interface. However, I am having to look through each object to find the proper method call and value. I had attempted to gleam some insight via CSV import but those fields don’t match all the methods. I reviewed one of the other open tickets, but I still wasn’t able to track down the proper way to do it. I would propose the documentation show simple call to add each of the various attributes. I am willing to contribute examples once I figure them out as well.
adam added the type: documentationstatus: revisions needed labels 2025-12-29 19:27:23 +01:00
adam closed this issue 2025-12-29 19:27:23 +01:00
adam commented 2025-12-29 19:27:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 20, 2021):

We're going to need more detail here. What specific examples would you include, and why? Bear in mind that the core documentation must remain maintainable long term, so arbitrary examples should be limited to those that are sure to provide value.

@jeremystretch commented on GitHub (Sep 20, 2021): We're going to need more detail here. What specific examples would you include, and why? Bear in mind that the core documentation must remain maintainable long term, so arbitrary examples should be limited to those that are sure to provide value.
adam commented 2025-12-29 19:27:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 28, 2021):

Closing as there's been no further response.

@jeremystretch commented on GitHub (Sep 28, 2021): Closing as there's been no further response.
adam commented 2025-12-29 19:27:24 +01:00
Author
Owner
Copy Link

@georgesnow commented on GitHub (Sep 28, 2021):

I haven’t had a chance to write up examples. I will open a new ticket when I write up some examples.

@georgesnow commented on GitHub (Sep 28, 2021): I haven’t had a chance to write up examples. I will open a new ticket when I write up some examples.
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: revisions needed type: documentation
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#5386
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?