K8s: Update common openapi generation scripts (#81857)

hack/README.md

@@ -23,9 +23,7 @@ go mod download
 # the happy path
 ./hack/update-codegen.sh
 
-# if wanting to agree to a change which introduces different openapi violations, run with the bool set to true
-UPDATE_API_KNOWN_VIOLATIONS=true ./hack/update-codegen.sh
-```
 
 Note that the script deletes existing openapi go code and regenerates in place so that you will temporarily see
 deleted files in your `git status`. After a successful run, you should see them restored.
+```

hack/openapi-codegen.sh

@@ -39,6 +39,7 @@ function grafana::codegen::gen_openapi() {
     local out_base=""
     local report="/dev/null"
     local update_report=""
+    local include_common_input_dirs=""
     local boilerplate="${KUBE_CODEGEN_ROOT}/hack/boilerplate.go.txt"
     local v="${KUBE_VERBOSE:-0}"
 
@@ -48,6 +49,14 @@ function grafana::codegen::gen_openapi() {
                 in_pkg_single="$2"
                 shift 2
                 ;;
+            "--include-common-input-dirs")
+                if [ "$2" == "true" ]; then
+                  COMMON_INPUT_DIRS='--input-dirs "k8s.io/apimachinery/pkg/apis/meta/v1" --input-dirs "k8s.io/apimachinery/pkg/runtime" --input-dirs "k8s.io/apimachinery/pkg/version"'
+                else
+                  COMMON_INPUT_DIRS=""
+                fi
+                shift 2
+                ;;
             "--output-base")
                 out_base="$2"
                 shift 2
@@ -143,6 +152,7 @@ function grafana::codegen::gen_openapi() {
             --output-base "${out_base}" \
             --output-package "${in_pkg_single}" \
             --report-filename "${new_report}" \
+            ${COMMON_INPUT_DIRS}  \
             "${inputs[@]}"
     fi
 

hack/update-codegen.sh

@@ -19,27 +19,26 @@ source "${CODEGEN_PKG}/kube_codegen.sh"
 source "$(dirname "${BASH_SOURCE[0]}")/openapi-codegen.sh"
 
 kube::codegen::gen_helpers \
-    --input-pkg-root github.com/grafana/grafana/pkg/apis \
-    --output-base "${OUTDIR}" \
-    --boilerplate "${SCRIPT_ROOT}/hack/boilerplate.go.txt"
+   --input-pkg-root github.com/grafana/grafana/pkg/apis \
+   --output-base "${OUTDIR}" \
+   --boilerplate "${SCRIPT_ROOT}/hack/boilerplate.go.txt"
 
 
-if [[ "${UPDATE_API_KNOWN_VIOLATIONS:-}" == "true" ]]; then
-    update_report="--update-report"
-fi
-
 for api_pkg in $(ls ./pkg/apis); do
   if [[ "${1-}" != "" && ${api_pkg} != $1 ]]; then
     continue
   fi
+  include_common_input_dirs=$([[ ${api_pkg} == "common" ]] && echo "true" || echo "false")
   for pkg_version in $(ls ./pkg/apis/${api_pkg}); do
     echo "Generating openapi package for ${api_pkg}, version=${pkg_version} ..."
+
     grafana::codegen::gen_openapi \
       --input-pkg-single github.com/grafana/grafana/pkg/apis/${api_pkg}/${pkg_version} \
       --output-base "${OUTDIR}" \
       --report-filename "${OPENAPI_VIOLATION_EXCEPTIONS_FILENAME}" \
-      ${update_report:+"${update_report}"} \
-      --boilerplate "${SCRIPT_ROOT}/hack/boilerplate.go.txt"
+      --update-report \
+      --boilerplate "${SCRIPT_ROOT}/hack/boilerplate.go.txt" \
+      --include-common-input-dirs ${include_common_input_dirs}
   done
 
   violations_file="${OUTDIR}/github.com/grafana/grafana/pkg/apis/${api_pkg}/${pkg_version}/${OPENAPI_VIOLATION_EXCEPTIONS_FILENAME}"

pkg/apis/common/v0alpha1/zz_generated.openapi_violation_exceptions.list

@@ -1 +1,37 @@
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIGroup,ServerAddressByClientCIDRs
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIGroup,Versions
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIGroupList,Groups
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIResource,Categories
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIResource,ShortNames
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIResourceList,APIResources
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIVersions,ServerAddressByClientCIDRs
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,APIVersions,Versions
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,ApplyOptions,DryRun
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,CreateOptions,DryRun
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,DeleteOptions,DryRun
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,FieldsV1,Raw
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,LabelSelector,MatchExpressions
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,LabelSelectorRequirement,Values
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,ObjectMeta,Finalizers
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,ObjectMeta,ManagedFields
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,ObjectMeta,OwnerReferences
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,PatchOptions,DryRun
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,RootPaths,Paths
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,StatusDetails,Causes
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,Table,ColumnDefinitions
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,Table,Rows
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,TableRow,Cells
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,TableRow,Conditions
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/apis/meta/v1,UpdateOptions,DryRun
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/runtime,RawExtension,Raw
+API rule violation: list_type_missing,k8s.io/apimachinery/pkg/runtime,Unknown,Raw
 API rule violation: names_match,github.com/grafana/grafana/pkg/apis/common/v0alpha1,Unstructured,Object
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,APIResourceList,APIResources
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,Duration,Duration
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,InternalEvent,Object
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,InternalEvent,Type
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,MicroTime,Time
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,StatusCause,Type
+API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,Time,Time
+API rule violation: names_match,k8s.io/apimachinery/pkg/runtime,Unknown,ContentEncoding
+API rule violation: names_match,k8s.io/apimachinery/pkg/runtime,Unknown,ContentType

pkg/apis/dashboardsnapshot/v0alpha1/zz_generated.openapi_violation_exceptions.list

@@ -1,3 +1,3 @@
 API rule violation: names_match,github.com/grafana/grafana/pkg/apis/dashboardsnapshot/v0alpha1,DashboardCreateResponse,DeleteURL
 API rule violation: names_match,github.com/grafana/grafana/pkg/apis/dashboardsnapshot/v0alpha1,SnapshotInfo,ExternalURL
-API rule violation: names_match,github.com/grafana/grafana/pkg/apis/dashboardsnapshot/v0alpha1,SnapshotSharingOptions,SnapshotsEnabled
+API rule violation: names_match,github.com/grafana/grafana/pkg/apis/dashboardsnapshot/v0alpha1,SnapshotSharingOptions,SnapshotsEnabled