ark-sdk-development

To regenerate TypeScript types from Kubernetes CRD changes, convert the CRD YAML to OpenAPI schemas, generate Python models, and update the dashboard types. This pipeline synchronizes SDK, API, and dashboard type definitions end-to-end.

Converting CRD YAML to OpenAPI schemas involves using a build pipeline script to parse the Kubernetes Custom Resource Definitions and translate them into standard OpenAPI schema definitions. Python models are then generated from these schemas for SDK use.

To apply overlay files to generated Python models, copy the overlay files into the specific generation directory. This manual alignment step refines the automatically generated code and maintains consistency with custom utilities.

Synchronizing types requires running the SDK build to regenerate SDK types, the API build to update models, and the dashboard generation command to refresh TypeScript types. These steps ensure compatibility across the entire stack.

Yes, you can use this pipeline to validate type compatibility when API surfaces change. It tracks changes from CRD to TypeScript types on the dashboard, ensuring compatibility and eliminating inconsistencies during schema evolutions.

Yes, you need the specific build pipeline scripts including the CRD to OpenAPI converter, the OpenAPI generator CLI, and the TypeScript generation steps. These components are required to execute the end-to-end type synchronization.