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

Define error responses for endpoints in the swagger spec #3972

New Issue
Closed
opened 2025-12-29 18:32:22 +01:00 by adam · 5 comments
adam commented 2025-12-29 18:32:22 +01:00
Owner
Copy Link

Originally created by @joakimhellum on GitHub (Aug 12, 2020).

Environment

  • Python version: N/A
  • NetBox version: 103a0e2b32d1 (v2.8.9)

Proposed Functionality

Define error responses for endpoints in the swagger spec.

Use Case

Currently the swagger spec does not have any default / error responses defined for the endpoints. This is an issue for some code generators like go-swagger and AutoRest.

We are facing some issues using the official NetBox SDK for Go which is generated by go-swagger. For example, the following error message is not very helpful:

unknown error (status 400): {}

I think this happens because we cannot obtain the underlying http.Response if the StatusCode is not defined in the swagger spec. We could implement workaround which allows http.Response.Body to be accessed anyway, but this feels very hacky.

Can we expect default / error responses to be added for the endpoints in the swagger spec in a future version?

Many thanks for your advice!

Database Changes

N/A

External Dependencies

Originally created by @joakimhellum on GitHub (Aug 12, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. 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: N/A * NetBox version: 103a0e2b32d1 (v2.8.9) <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Define error responses for endpoints in the swagger spec. <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case Currently the swagger spec does not have any default / error responses defined for the endpoints. This is an issue for some code generators like `go-swagger` and `AutoRest`. We are facing some issues using the [official NetBox SDK for Go](https://github.com/netbox-community/go-netbox) which is generated by `go-swagger`. For example, the following error message is not very helpful: ``` unknown error (status 400): {} ``` I think this happens because we cannot obtain the underlying `http.Response` if the StatusCode is not defined in the swagger spec. We could implement workaround which allows `http.Response.Body` to be accessed anyway, but this feels very hacky. Can we expect default / error responses to be added for the endpoints in the swagger spec in a future version? Many thanks for your advice! <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes N/A <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies
adam added the type: bugstatus: needs ownerpending closure labels 2025-12-29 18:32:22 +01:00
adam closed this issue 2025-12-29 18:32:23 +01:00
adam commented 2025-12-29 18:32:23 +01:00
Author
Owner
Copy Link

@lampwins commented on GitHub (Aug 12, 2020):

@joakimhellum are you able to take this issue on? We currently only support the swagger spec as best effort due to the way in which it is generated, so without community support, this is not likely to get much traction.

@lampwins commented on GitHub (Aug 12, 2020): @joakimhellum are you able to take this issue on? We currently only support the swagger spec as best effort due to the way in which it is generated, so without community support, this is not likely to get much traction.
adam commented 2025-12-29 18:32:23 +01:00
Author
Owner
Copy Link

@joakimhellum commented on GitHub (Aug 12, 2020):

@lampwins Yes, happy to take on this issue. We already started experimenting with this at work last week.

@joakimhellum commented on GitHub (Aug 12, 2020): @lampwins Yes, happy to take on this issue. We already started experimenting with this at work last week.
adam commented 2025-12-29 18:32:23 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 4, 2020):

@joakimhellum Have you been able to make any progress with this?

@jeremystretch commented on GitHub (Sep 4, 2020): @joakimhellum Have you been able to make any progress with this?
adam commented 2025-12-29 18:32:23 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Oct 30, 2020):

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. Please see our contributing guide.

@stale[bot] commented on GitHub (Oct 30, 2020): 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. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 18:32:23 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Nov 14, 2020):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@stale[bot] commented on GitHub (Nov 14, 2020): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 pending closure status: needs owner 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#3972
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?