Skip to content

Commit e2a9f2b

Browse files
dflemstrfrankfarzan
authored andcommitted
Mention detailed defaulting behavior in function docstring
1 parent 975d131 commit e2a9f2b

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

ts/demo-functions/src/kubeval.ts

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,17 @@ function readStdoutToString(childProcess: ChildProcess): Promise<string> {
157157
kubeval.usage = `
158158
Validates configuration using kubeval.
159159
160-
Configured using a ConfigMap with the following keys:
161-
${SCHEMA_LOCATION}: Comma-seperated list of secondary base URLs used to download schemas.
162-
${ADDITIONAL_SCHEMA_LOCATIONS}: List of secondary base URLs used to download schemas.
163-
${IGNORE_MISSING_SCHEMAS}: Skip validation for resource definitions without a schema.
164-
${SKIP_KINDS}: Comma-separated list of case-sensitive kinds to skip when validating against schemas.
165-
${STRICT}: Disallow additional properties not in schema.
160+
Configured using a ConfigMap with the following keys, all of which are optional:
161+
${SCHEMA_LOCATION}: The base URL used to download schemas. If not specified,
162+
the default location at https://kubernetesjsonschema.dev/ will be used.
163+
${ADDITIONAL_SCHEMA_LOCATIONS}: List of secondary base URLs used to download
164+
schemas. These URLs will be used if the URL specified by ${SCHEMA_LOCATION}
165+
did not have the required schema. By default, there are no secondary URLs,
166+
and only the primary base URL will be used.
167+
${IGNORE_MISSING_SCHEMAS}: Skip validation for resource definitions without a
168+
schema. If omitted, a default value of false will be assumed.
169+
${SKIP_KINDS}: Comma-separated list of case-sensitive kinds to skip when
170+
validating against schemas. If omitted, no kinds will be skipped.
171+
${STRICT}: Disallow additional properties not in schema. If omitted, a default
172+
value of false will be assumed.
166173
`;

0 commit comments

Comments
 (0)