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

Add pre-commit check for changes to OpenAPI schema #11544

New Issue
Closed
opened 2025-12-29 21:46:36 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:46:36 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Aug 29, 2025).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

  1. Commit a static copy of NetBox's OpenAPI schema (the JSON data published at /api/schema/)*
  2. Introduce a pre-commit check that regenerates this file and fails if any changes are detected

* Use of this static file for other purposes should be discouraged as it is limited to the base API schema, and does not include any plugins installed in the user's own NetBox deployment.

Justification

The goal here is to implement a check for NetBox's OpenAPI schema to mitigate unexpected changes. Should the pre-commit check fail, the author will need to either update the schema as part of the commit, or make adjustments to avoid the unexpected change. (Changes are generally anticipated only for breaking releases.)

Originally created by @jeremystretch on GitHub (Aug 29, 2025). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes 1. Commit a static copy of NetBox's OpenAPI schema (the JSON data published at `/api/schema/`)\* 2. Introduce a `pre-commit` check that regenerates this file and fails if any changes are detected \* Use of this static file for other purposes should be discouraged as it is limited to the base API schema, and does not include any plugins installed in the user's own NetBox deployment. ### Justification The goal here is to implement a check for NetBox's OpenAPI schema to mitigate unexpected changes. Should the pre-commit check fail, the author will need to either update the schema as part of the commit, or make adjustments to avoid the unexpected change. (Changes are generally anticipated only for breaking releases.)
adam added the status: acceptedtype: housekeeping labels 2025-12-29 21:46:36 +01:00
adam closed this issue 2025-12-29 21:46:36 +01:00
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: housekeeping
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#11544
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?