kata-api-design-oas

To generate an OpenAPI 3.x YAML specification, provide your feature's base path, resources, and authentication style. The skill derives REST operations, paths, request/response payloads, and status codes to output a compliant OAS file.

You document idempotency for REST API mutations by enforcing an Idempotency-Key header within the OpenAPI specification. The skill automatically applies this header to mutation operations to satisfy idempotency requirements.

The best way to ensure consistent pagination and sorting documentation is to apply standardized conventions to list endpoints. The skill enforces pagination and sorting rules directly within the generated OpenAPI 3.x contract.

You do not need to manually define standardized error structures for every endpoint. The skill enforces consistent error structures across all REST API operations during the OpenAPI 3.x spec generation process.

Yes, you can persist the generated OpenAPI YAML file automatically. The skill saves the output specification to the docs/{context}/oas/openapi.yaml directory path through the kata-feature-design-docs workflow.