starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-13 13:53:31 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Automatically build JSON schema for the device type library with each release #6816

New Issue
Closed
opened 2025-12-29 19:45:44 +01:00 by adam · 4 comments
adam commented 2025-12-29 19:45:44 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Aug 16, 2022).

Originally assigned to: @danner26 on GitHub.

NetBox version

v3.2.9

Feature type

New functionality

Proposed functionality

Implement a mechanism for generating JSON schema for device type and related definitions. This could be a Django management command (e.g. manage.py buildschema), the output of which would be included with each NetBox release.

Use case

The NetBox devicetype library includes JSON schema for validating device and module type definitions. These definitions must be kept up-to-date with NetBox itself, which is currently a manual process. Generating the schema automatically and publishing it with each NetBox release will remove this administrative burden.

Additionally, once we implement #4347, schema can be generated for all relevant models as an additional resource.

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Aug 16, 2022). Originally assigned to: @danner26 on GitHub. ### NetBox version v3.2.9 ### Feature type New functionality ### Proposed functionality Implement a mechanism for generating JSON schema for device type and related definitions. This could be a Django management command (e.g. `manage.py buildschema`), the output of which would be included with each NetBox release. ### Use case The NetBox [devicetype library](https://github.com/netbox-community/devicetype-library) includes [JSON schema](https://github.com/netbox-community/devicetype-library/tree/master/schema) for validating device and module type definitions. These definitions must be kept up-to-date with NetBox itself, which is currently a manual process. Generating the schema automatically and publishing it with each NetBox release will remove this administrative burden. Additionally, once we implement #4347, schema can be generated for all relevant models as an additional resource. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 19:45:44 +01:00
adam closed this issue 2025-12-29 19:45:44 +01:00
adam commented 2025-12-29 19:45:44 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Nov 16, 2022):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Nov 16, 2022): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 19:45:44 +01:00
Author
Owner
Copy Link

@ryanmerolle commented on GitHub (Apr 25, 2023):

This could be a good candidate for 3.6

@ryanmerolle commented on GitHub (Apr 25, 2023): This could be a good candidate for 3.6
adam commented 2025-12-29 19:45:44 +01:00
Author
Owner
Copy Link

@danner26 commented on GitHub (Aug 1, 2023):

I agree this would be great!

@danner26 commented on GitHub (Aug 1, 2023): I agree this would be great!
adam commented 2025-12-29 19:45:44 +01:00
Author
Owner
Copy Link

@danner26 commented on GitHub (Aug 4, 2023):

I have marked the PR as ready for review. This should be ready to be merged. Let me know if you need anything changed

@danner26 commented on GitHub (Aug 4, 2023): I have marked the PR as ready for review. This should be ready to be merged. Let me know if you need anything changed
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#6816
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?