Skip to content

Docs: CRD reference shows missing external types (e.g., AuthType) #2564

@tao12345666333

Description

@tao12345666333

Problem Statement

The generated CRD reference docs include fields that reference external SDK types (e.g., AuthType, CreateControlPlaneRequestClusterType, ControlPlaneClusterType, ProxyURL). These types aren’t defined in our repo, so the docs render links like AuthType without a corresponding “Types” section, causing dead anchors and confusion. In the CRD OpenAPI, these are plain string (or object) types.

Proposed Solution

  1. Add a post-process, convert these types to string(or object) types.
  2. Define local alias types (string) for docs and convert to SDK types at the controller boundary.
  3. Extend/fork the generator to support a mapping config from external types to primitives.

Additional Information

...

Acceptance Criteria

  • No dead anchors for the above external types across generated docs.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions