Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
jeremystretch opened this issue Aug 16, 2022 · 4 comments · Fixed by #13353
Closed

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

jeremystretch opened this issue Aug 16, 2022 · 4 comments · Fixed by #13353
Assignees
@danner26
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application

Comments

@jeremystretch
Copy link
Member

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
@jeremystretch jeremystretch added type: feature Introduction of new functionality to the application status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Aug 16, 2022
@jeremystretch jeremystretch added status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Sep 16, 2022
@github-actions
Copy link
Contributor

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 github-actions bot added the pending closure Requires immediate attention to avoid being closed for inactivity label Nov 16, 2022
@jeremystretch jeremystretch added needs milestone Awaiting prioritization for inclusion with a future NetBox release and removed status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation pending closure Requires immediate attention to avoid being closed for inactivity labels Dec 15, 2022
@ryanmerolle
Copy link
Contributor

This could be a good candidate for 3.6

@danner26
Copy link
Member

danner26 commented Aug 1, 2023

I agree this would be great!

@danner26 danner26 self-assigned this Aug 2, 2023
danner26 added a commit to danner26/devicetype-library that referenced this issue Aug 2, 2023
@danner26
Adding generated schema in preperation of PR for [NetBox Issue 10030](n…
54afe2b 
…etbox-community/netbox#10030)
@danner26 danner26 mentioned this issue Aug 2, 2023
Merged
danner26 added a commit to netbox-community/devicetype-library that referenced this issue Aug 2, 2023
@danner26
Adding generated schema in preperation of PR for [NetBox Issue 10030](n…
5d99d93 
…etbox-community/netbox#10030) (#1525)
@danner26 danner26 mentioned this issue Aug 2, 2023
Merged
@danner26
Copy link
Member

danner26 commented 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

@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed needs milestone Awaiting prioritization for inclusion with a future NetBox release labels Aug 11, 2023
jeremystretch added a commit that referenced this issue Aug 14, 2023
@jeremystretch
Changelog for #10030, #11578, #12639
b9b9c06
@jeremystretch jeremystretch mentioned this issue Aug 15, 2023
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@danner26 danner26

Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature - Schema Generation danner26/netbox
3 participants
@danner26 @ryanmerolle @jeremystretch