carvel-dev / carvel-dev/ytt

Add support for jsonschema export similar to openapi-v3

Open
#898 5 comments 0 reactions 1 assignee Assigned to @cppforlife View on GitHub
enhancement
Dominant language
Go
Stars
1.9k
Forks
167
PR merge metrics
No merged PRs in 30d

Description

**Describe the problem/challenge you have**
Most text editors use json schema, to autocomplete and validate YAML files. To make it easier to the users, to write YAML files based on a YTT schema, it would be great to have a way to create the json schema from a YTT file, similar to the openapi schema that is currently implemented.

**Describe the solution you'd like**
Support for json schema as a output option for ` ytt -f schema.yaml --data-values-schema-inspect --output`

**Anything else you would like to add:**
During kubecon 2024, the talk [Developers demand UX for K8s](https://kccnceu2024.sched.com/event/1YeNM/developers-demand-ux-for-k8s-mairin-duffy-red-hat-inc-conor-cowman-atlantic-technological-university?iframe=no) highlighted that YAML validation & auto-completion seems to be one of the main struggles developers face when working with Kubernetes.

Using YTT and it's schemas, could help alleviate that issue.

---
Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.