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

[PR #20230] [MERGED] Closes #20203: Add a pre-commit check for OpenAPI schema changes #15855

New Issue
Closed
opened 2025-12-30 00:24:25 +01:00 by adam · 0 comments
adam commented 2025-12-30 00:24:25 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/20230
Author: @jeremystretch
Created: 9/2/2025
Status: ✅ Merged
Merged: 9/5/2025
Merged by: @arthanson

Base: main ← Head: 20203-openapi-check

📝 Commits (1)

  • 8142f26 Closes #20203: Add a pre-commit check for OpenAPI schema changes

📊 Changes

4 files changed (+256594 additions, -10 deletions)

View changed files

📝 .pre-commit-config.yaml (+8 -0)
➕ contrib/openapi.json (+256546 -0)
📝 docs/development/release-checklist.md (+18 -10)
➕ scripts/verify-openapi.sh (+22 -0)

📄 Description

Closes: #20203

  • Add a static record of the OpenAPI schema at contrib/openapi.json
  • Introduce the verify-openapi.sh script to generate the OpenAPI schema & compare it to the static record
  • Add a pre-commit rule to run the OpenAPI verification check
  • Update the release documentation to include updating contrib/openapi.json

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/20230 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 9/2/2025 **Status:** ✅ Merged **Merged:** 9/5/2025 **Merged by:** [@arthanson](https://github.com/arthanson) **Base:** `main` ← **Head:** `20203-openapi-check` --- ### 📝 Commits (1) - [`8142f26`](https://github.com/netbox-community/netbox/commit/8142f265d8d6d2ecbe8e8495f42d0d20d9b96664) Closes #20203: Add a pre-commit check for OpenAPI schema changes ### 📊 Changes **4 files changed** (+256594 additions, -10 deletions) <details> <summary>View changed files</summary> 📝 `.pre-commit-config.yaml` (+8 -0) ➕ `contrib/openapi.json` (+256546 -0) 📝 `docs/development/release-checklist.md` (+18 -10) ➕ `scripts/verify-openapi.sh` (+22 -0) </details> ### 📄 Description ### Closes: #20203 - Add a static record of the OpenAPI schema at `contrib/openapi.json` - Introduce the `verify-openapi.sh` script to generate the OpenAPI schema & compare it to the static record - Add a `pre-commit` rule to run the OpenAPI verification check - Update the release documentation to include updating `contrib/openapi.json` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 00:24:25 +01:00
adam closed this issue 2025-12-30 00:24:25 +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 pull-request
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#15855
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?