From 278385f4c9c0abd6d5c917d01b79e0352254b46d Mon Sep 17 00:00:00 2001 From: "Yamamoto, Hirotaka" Date: Sun, 9 Jul 2023 20:46:12 +0900 Subject: [PATCH] Update Readme.md to add `fullgroup` explanation (#220) This is a follow-up to #219 to add a short description on how to use the `fullgroup` variable. --- Readme.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index ce90ed6..498f84f 100644 --- a/Readme.md +++ b/Readme.md @@ -256,12 +256,16 @@ $ python ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/a JSON schema written to trainingjob_v1.json ``` -By default, the file name output format is `{kind}_{version}`. The `FILENAME_FORMAT` environment variable can be used to change the output file name (Available variables: `kind`, `group`, `version`): +By default, the file name output format is `{kind}_{version}`. The `FILENAME_FORMAT` environment variable can be used to change the output file name (Available variables: `kind`, `group`, `fullgroup`, `version`): ``` $ export FILENAME_FORMAT='{kind}-{group}-{version}' $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob-sagemaker-v1.json + +$ export FILENAME_FORMAT='{kind}-{fullgroup}-{version}' +$ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml +JSON schema written to trainingjob-sagemaker.aws.amazon.com-v1.json ``` After converting your CRDs to JSON schema files, you can use `kubeconform` to validate your CRs against them: