Skip to content

Compatibility

The SDK targets Okatana External API v1 and pins the source contract in resources/openapi.yaml.

Compatibility rules:

  • /api/v1 is the versioned external surface;
  • unknown properties on typed response models are preserved;
  • dynamic responses retain every returned field;
  • documented enum values are modeled explicitly;
  • request validation follows the pinned schema rather than an assumed server implementation;
  • endpoint coverage is tested by method and path;
  • the SDK does not automate the internal /app-api/* session interface.

If a server introduces a new required request field or changes an existing response incompatibly without a new API version, treat it as a contract break and update the pinned specification and SDK together.