Skip to content

Commit e04b5f9

Browse files
authored
docs: update CLI & config usage in README.md (#265)
1 parent 9ad2e22 commit e04b5f9

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,12 @@ Flags:
130130
--bundle-without-id Bundle without using $id to reference bundled schemas, which improves compatibility with e.g the VS Code JSON extension
131131
--config string Config file for setting defaults. (default ".schema.yaml")
132132
--draft int Draft version (4, 6, 7, 2019, or 2020) (default 2020)
133-
-h, --help help for helm
133+
-h, --help help for helm schema
134134
--indent int Indentation spaces (even number) (default 4)
135-
--k8s-schema-url string URL template used in $ref: $k8s/... alias (default "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/refs/heads/master/{{ .K8sSchemaVersion }}/")
135+
--k8s-schema-url string URL template used in $ref: $k8s/... alias (default "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .K8sSchemaVersion }}/")
136136
--k8s-schema-version string Version used in the --k8s-schema-url template for $ref: $k8s/... alias
137137
--no-additional-properties Default additionalProperties to false for all objects in the schema
138+
--no-default-global Disable automatic injection of 'global' property when schema root does not allow it
138139
-o, --output string Output file path (default "values.schema.json")
139140
--schema-root.additional-properties Allow additional properties
140141
--schema-root.description string JSON schema description
@@ -143,6 +144,7 @@ Flags:
143144
--schema-root.title string JSON schema title
144145
--use-helm-docs Read description from https://github.com/norwoodj/helm-docs comments
145146
-f, --values strings One or more YAML files as inputs. Use comma-separated list or supply flag multiple times (default [values.yaml])
147+
-v, --version version for helm schema
146148
```
147149

148150
### Configuration file
@@ -165,9 +167,13 @@ bundle: false
165167
bundleRoot: ""
166168
bundleWithoutID: false
167169
170+
k8sSchemaURL: https://raw.githubusercontent.com/yannh/kubernetes-json-schema/refs/heads/master/{{ .K8sSchemaVersion }}/
171+
k8sSchemaVersion: "v1.33.1"
172+
168173
useHelmDocs: false
169174
170175
noAdditionalProperties: false
176+
noDefaultGlobal: false
171177
172178
schemaRoot:
173179
id: https://example.com/schema

0 commit comments

Comments
 (0)