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: adding required fields #38

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

Feature request: adding required fields #38

jdomag opened this issue Apr 4, 2022 · 4 comments
Labels

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.

@miguelaeh
Copy link
Contributor

Hi @jdomag ,
Could you elaborate on what do you mean?
Generating the schema with this tool will include every single value that appears on the values.yaml as an Open API compliant schema.

@jdomag
Copy link
Author

jdomag commented Apr 7, 2022

Hi,
I was wondering how to generate schema presented below:

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "image": {
      "type": "object",
      "required": [
        "repository",
        "pullPolicy"
      ]
}

Is there any way to mark "repository" and "pullPolicy", as required fields?

@miguelaeh
Copy link
Contributor

I see your point now.
I am afraid such a feature is not implemented right now. If you happen to modify the code to make it work we will really appreciate a PR.

@kevinvancleef
Copy link

@miguelaeh I'm happy to look into implementing this feature. Would you like to see it as a modifier (like nullable) or as a new tag?

@fmulero fmulero added bug Something isn't working triage and removed bug Something isn't working labels Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants