Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidArtifact = errors.New("invalid openapi types artifact")
ErrInvalidArtifact reports an unusable OpenAPI TypeScript generation artifact.
var ErrMissingGeneratedFile = errors.New("generated file is missing")
ErrMissingGeneratedFile reports that the committed generated file does not exist.
var ErrStaleGeneratedFile = errors.New("generated file is stale")
ErrStaleGeneratedFile reports that the committed generated file no longer matches the source spec.
Functions ¶
func Check ¶
Check regenerates one artifact into a temporary file and fails when the checked-in output differs.
func CheckSDK ¶
func CheckSDK(ctx context.Context, artifact SDKArtifact) error
CheckSDK rejects missing, changed, or obsolete generated SDK files.
func Generate ¶
Generate runs openapi-typescript for one artifact and formats the generated output with oxfmt.
func GenerateSDK ¶
func GenerateSDK(ctx context.Context, artifact SDKArtifact) error
GenerateSDK publishes the public resource SDK and internal stream bindings.
Types ¶
type SDKArtifact ¶
SDKArtifact describes the two generated SDK jobs and their shared source.