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

Hosted OpenAPI documentation #7724

New Issue
Closed
opened 2025-12-29 20:27:31 +01:00 by adam · 1 comment
adam commented 2025-12-29 20:27:31 +01:00
Owner
Copy Link

Originally created by @bcftv on GitHub (Mar 6, 2023).

NetBox version

v3.4.5

Feature type

New functionality

Proposed functionality

The OpenAPI documentation on our personal instance is not accessible externally for ingestion into other services like https://github.com/APIs-guru/openapi-directory which is used to allow easy API integration with ServiceNow.

In Open API Directory Issue 876 I provided a link to the API definition on the demo instance which is publicly accessible.

But this is very slow to respond and times-out when they try to retrieve it.

Is it possible to host the current release API documentation directly in GitHub?

Use case

The OpenAPI documentation on our personal instance is not accessible externally for ingestion into other services like https://github.com/APIs-guru/openapi-directory which is used to allow easy API integration with ServiceNow.

Database changes

None

External dependencies

None

Originally created by @bcftv on GitHub (Mar 6, 2023). ### NetBox version v3.4.5 ### Feature type New functionality ### Proposed functionality The OpenAPI documentation on our personal instance is not accessible externally for ingestion into other services like https://github.com/APIs-guru/openapi-directory which is used to allow easy API integration with ServiceNow. In [Open API Directory Issue 876](https://github.com/APIs-guru/openapi-directory/issues/876) I provided a link to the [API definition on the demo instance](https://netbox.wikimedia.org/api/docs/?format=openapi) which is publicly accessible. But this is very slow to respond and times-out when they try to retrieve it. Is it possible to host the current release API documentation directly in GitHub? ### Use case The OpenAPI documentation on our personal instance is not accessible externally for ingestion into other services like https://github.com/APIs-guru/openapi-directory which is used to allow easy API integration with ServiceNow. ### Database changes None ### External dependencies None
adam added the type: feature label 2025-12-29 20:27:31 +01:00
adam closed this issue 2025-12-29 20:27:31 +01:00
adam commented 2025-12-29 20:27:31 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 16, 2023):

The API schema for an individual NetBox deployment will vary depending on its version, what plugins are installed, and (potentially) how it is configured. Thus any centrally published schema will be of limited utility. You can download the schema for your NetBox instance from /api/docs/?format=openapi to share with interested parties.

I provided a link to the API definition on the demo instance which is publicly accessible.

You appear to have linked to Wikimedia's NetBox deployment. Our public demo instance is at https://demo.netbox.dev.

But this is very slow to respond and times-out when they try to retrieve it.

The schema is generated upon the first request, and then cached for so that it is immediately available for successive requests.

@jeremystretch commented on GitHub (Mar 16, 2023): The API schema for an individual NetBox deployment will vary depending on its version, what plugins are installed, and (potentially) how it is configured. Thus any centrally published schema will be of limited utility. You can download the schema for your NetBox instance from `/api/docs/?format=openapi` to share with interested parties. > I provided a link to the [API definition on the demo instance](https://netbox.wikimedia.org/api/docs/?format=openapi) which is publicly accessible. You appear to have linked to Wikimedia's NetBox deployment. Our public demo instance is at https://demo.netbox.dev. > But this is very slow to respond and times-out when they try to retrieve it. The schema is generated upon the first request, and then cached for so that it is immediately available for successive requests.
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 type: feature
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#7724
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?