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

Cache /api/schema/ endpoint #9561

New Issue
Closed
opened 2025-12-29 21:18:58 +01:00 by adam · 2 comments
adam commented 2025-12-29 21:18:58 +01:00
Owner
Copy Link

Originally created by @mulmat on GitHub (Apr 30, 2024).

Originally assigned to: @mulmat on GitHub.

NetBox version

v3.7.6

Feature type

Change to existing functionality

Proposed functionality

Add caching on the /api/schema/ endpoint with a sane default (maybe 300 seconds?) and with the possibility to configure it in configuration.py

Use case

Generating openapi schema takes some time, caching it would:

  • Decrease response time when doing multiple calls to /api/schema/
  • Lower the resources needed from application server (since less openapi schemas will be generated)

Database changes

None

External dependencies

None

Originally created by @mulmat on GitHub (Apr 30, 2024). Originally assigned to: @mulmat on GitHub. ### NetBox version v3.7.6 ### Feature type Change to existing functionality ### Proposed functionality Add caching on the `/api/schema/ ` endpoint with a sane default (maybe 300 seconds?) and with the possibility to configure it in configuration.py ### Use case Generating openapi schema takes some time, caching it would: - Decrease response time when doing multiple calls to `/api/schema/` - Lower the resources needed from application server (since less openapi schemas will be generated) ### Database changes None ### External dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 21:18:58 +01:00
adam closed this issue 2025-12-29 21:18:59 +01:00
adam commented 2025-12-29 21:18:59 +01:00
Author
Owner
Copy Link

@mulmat commented on GitHub (Apr 30, 2024):

I can own this if accepted

@mulmat commented on GitHub (Apr 30, 2024): I can own this if accepted
adam commented 2025-12-29 21:19:00 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 30, 2024):

We actually used to cache the schema definition back in ~v2.11 (see #6423 and 257c0afdb5), before we switched from drf-yasg to spectacular. Unfortunately I don't think spectacular offers caching support natively, so we'd have to implement it ourselves.

@mulmat happy to assign this to you to explore options. Let us know what you find!

@jeremystretch commented on GitHub (Apr 30, 2024): We actually used to cache the schema definition back in ~v2.11 (see #6423 and 257c0afdb5b62c7ea84159d2b46d53ce5a43f3a3), before we switched from drf-yasg to spectacular. Unfortunately I don't think spectacular offers caching support natively, so we'd have to implement it ourselves. @mulmat happy to assign this to you to explore options. Let us know what you find!
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: 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#9561
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?