Skip to content

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

@jeremystretch

Description

@jeremystretch

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

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions