bitnami / readme-generator-for-helm

Auto generate READMEs for Helm Charts
https://bitnami.com
Apache License 2.0
212 stars 48 forks source link

Feature request: adding required fields #38

Open jdomag opened 2 years ago

jdomag commented 2 years ago

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

miguelaeh commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 1 year ago

@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?