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

Move the OpenAPI schema check from pre-commit to CI #11792

New Issue
Closed
opened 2025-12-29 21:49:56 +01:00 by adam · 1 comment
adam commented 2025-12-29 21:49:56 +01:00
Owner
Copy Link

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

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

  • Remove the pre-commit rule which calls the verify-openapi.sh script if any API files have been modified.
  • Add a step in ci.yml to run the script

Justification

Generating the OpenAPI schema takes a considerable amount of time, which would be disruptive if we had to do it for every commit. We applied the file path check to the pre-commit rule in an effort to mitigate this, however we've found that changes not captured by this qualifier can still result in changes to the spec.

Moving this check to CI will be less disruptive for individual developers while also ensuring consistent coverage, without significantly impacting the duration of a CI job.

Originally created by @jeremystretch on GitHub (Oct 29, 2025). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes - Remove the pre-commit rule which calls the `verify-openapi.sh` script if any API files have been modified. - Add a step in `ci.yml` to run the script ### Justification Generating the OpenAPI schema takes a considerable amount of time, which would be disruptive if we had to do it for _every_ commit. We applied the file path check to the pre-commit rule in an effort to mitigate this, however we've found that changes not captured by this qualifier can still result in changes to the spec. Moving this check to CI will be less disruptive for individual developers while also ensuring consistent coverage, without significantly impacting the duration of a CI job.
adam added the status: acceptedtype: housekeepingnetbox labels 2025-12-29 21:49:56 +01:00
adam closed this issue 2025-12-29 21:49:56 +01:00
adam commented 2025-12-29 21:49:57 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 31, 2025):

Ran into some issues running manage.py spectacular in CI (it appears to need a database in place?) so I'll likely just remove it from the workflow as it's become more trouble than it's worth. Will keep the script itself in place though.

@jeremystretch commented on GitHub (Oct 31, 2025): Ran into some issues running `manage.py spectacular` in CI (it appears to need a database in place?) so I'll likely just remove it from the workflow as it's become more trouble than it's worth. Will keep the script itself in place though.
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 netbox 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#11792
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?