From 66316083a56eb438bc25a10552828f47a1ff5846 Mon Sep 17 00:00:00 2001 From: Catherine Fang Date: Tue, 3 Jan 2023 14:08:57 -0500 Subject: [PATCH 1/2] Update doc about json tag is needed to generate informer externalverion package Kubernetes-commit: e98a28e5c78e9d6bf428ecd614ddf62083b0ea9a --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index cbd55a51..d7e7fe18 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,9 @@ type User struct { } ``` +Note, json tag `json:` is needed to generate informer externalversions package. +Otherwise, informer internalversion package is generated. + ## Validation To validate custom resources, use the [`CustomResourceValidation`](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#validation) feature. Validation in the form of a [structured schema](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#specifying-a-structural-schema) is mandatory to be provided for `apiextensions.k8s.io/v1`. From c1519a0932bf1e85f3705d5df274e892d61fd726 Mon Sep 17 00:00:00 2001 From: CatherineF-dev Date: Wed, 4 Jan 2023 08:01:48 -0500 Subject: [PATCH 2/2] Update staging/src/k8s.io/sample-controller/README.md Co-authored-by: Joel Speed Kubernetes-commit: 2d4eefe9396fc71c9900992371c35a17f3647932 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d7e7fe18..3b73b33a 100644 --- a/README.md +++ b/README.md @@ -126,8 +126,7 @@ type User struct { } ``` -Note, json tag `json:` is needed to generate informer externalversions package. -Otherwise, informer internalversion package is generated. +Note, the JSON tag `json:` is required on all user facing fields within your type. Typically API types contain only user facing fields. When the JSON tag is omitted from the field, Kubernetes generators consider the field to be internal and will not expose the field in their generated external output. For example, this means that the field would not be included in a generated CRD schema. ## Validation