kcl-lang / kcl-openapi / 35564743446

65%

Build Type

push

github

Committed by web-flow

Commit Message

feat(generator): short, organized schema names for CRD imports (#180)

Fixes #179. Importing a CRD used to produce schema names glued from the
full property path, e.g.
ArgoprojIoV1alpha1ClusterWorkflowTemplateSpecAffinityNodeAffinity...
PreferredDuringSchedulingIgnoredDuringExecutionItems0PreferenceMatchFieldsItems0.

The names came from the code generator naming anonymous inline objects
after their property path within the root definition. This change adds a
post-flatten pass (pkg/swagger/generator/names.go) that:

- renames each CRD root definition (group.version.Kind) after its Kind,
  appending the version when several versions share the Kind;
- hoists every inline complex object below the roots into its own named
  definition, named after the short root plus at most two trailing
  meaningful path segments, dropping noise segments such as array
  "items"/"0" (e.g. ClusterWorkflowTemplatePreferenceMatchFields); on
  collision the name extends towards the root (capped) and then takes a
  numeric suffix, all assigned deterministically from a shared registry;
- rewrites every local $ref accordingly. Hoisted definitions render as
  their own model file with plain same-package references.

CRD-derived definitions are recognized by an x-kcl-crd-root marker set
during CRD->swagger conversion, so bundled k8s types and plain OpenAPI
specs are untouched. --long-names restores the previous behavior.

Two related optional modes:

- --crd-dedupe-k8s (dedupe.go): CRD definitions that are structurally
  identical to a bundled k8s type (e.g. a PodSpec inlined by
  argo-workflows) become x-kcl-type aliases to the official k8s module
  instead of duplicated local schemas (166 aliases on the argo CRD from
  the issue). Structures are compared canonically: descriptions and
  ordering annotations ignored, $refs resolved recursively, required
  sorted, x-kubernetes-* extensions and constraints kept; when several
  k8s API versions collide, the shortest (stable) import p... (continued)

Coverage Stats

532 of 703 new or added lines in 8 files covered. (75.68%)

60 existing lines in 3 files now uncovered.

3141 of 4853 relevant lines covered (64.72%)

0.73 hits per line