Minimal

The smallest valid opensdk.yaml — just the three required fields. Generators apply their own idiomatic defaults for everything omitted.


Only three fields are required. Generators apply their own idiomatic defaults for everything omitted. This is a valid starting point for any API.

# yaml-language-server: $schema=https://opensdks.org/schema/v1/opensdk.schema.json

opensdk: "1.0.0"

openapi:
  $ref: "./openapi.yaml"

sdk:
  name: "my-api"
  version: "1.0.0"

From here you can incrementally add languages, codegenRules, and any other fields as your SDK publishing needs grow. There’s no requirement to configure everything upfront.