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.

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

Feature Request: support for required/mandatory values #133

Open
jdomag opened this issue Apr 4, 2022 · 2 comments
Open

Feature Request: support for required/mandatory values #133

jdomag opened this issue Apr 4, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@jdomag
Copy link

jdomag commented Apr 4, 2022

Would be great to mark some fields mandatory/required as per values.schema.json specification. Generated doc table should contain corresponding column.

@norwoodj
Copy link
Owner

I think this is a good idea, there is no values.schema.json integration at this time and that'd be a nice thing to add. It's not something I have time to do right now, however

@norwoodj norwoodj added the enhancement New feature or request label Apr 25, 2022
@Grraahaam
Copy link

Hey! For future people looking for this feature, you can combine two tools together to get the expected documentation + values.schema.json:

Here's the documentation on how to integrate both together: helm-docs integration

Also being discussed here: #90 (comment)

# @schema
# required: true
# type: [string, null]
# @schema
# -- Override release name
nameOverride: ""

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

3 participants