Render Config Contexts as YAML in GUI #2712

Closed
opened 2025-12-29 18:21:16 +01:00 by adam · 0 comments
Owner

Originally created by @tyler-8 on GitHub (Jul 1, 2019).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.5.13

Proposed Functionality

When creating/viewing configuration contexts via the Netbox GUI, allow for using YAML instead of JSON.

Use Case

YAML is more human readable and easier to type/format when manually editing. Since YAML is a superset of JSON, the API would still use JSON and the storage would still be done as JSON - this would purely be for frontend rendering.

Database Changes

N/A

External Dependencies

Likely one of these:

  • ruamel.yaml
  • pyyaml
Originally created by @tyler-8 on GitHub (Jul 1, 2019). <!-- NOTE: This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.6.8<!-- Example: 3.5.4 --> * NetBox version: 2.5.13<!-- Example: 2.3.6 --> <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality When creating/viewing configuration contexts via the Netbox GUI, allow for using YAML instead of JSON. <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case YAML is more human readable and easier to type/format when manually editing. Since YAML is a superset of JSON, the API would still use JSON and the storage would still be done as JSON - this would purely be for frontend rendering. <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes N/A <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies Likely one of these: - ruamel.yaml - pyyaml
adam added the status: acceptedtype: feature labels 2025-12-29 18:21:16 +01:00
adam closed this issue 2025-12-29 18:21:16 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2712