Compatibility policy

The SDK is pinned to the supplied Okatana External API OpenAPI 3.1 document, version 1.0.0.

Compatible response growth

Models use JsonExtensionData so unknown object properties are retained. Consumers should read required known fields and ignore new optional fields unless they need them. JSON key order is irrelevant.

Enum growth

Enums are strongly typed. A server that introduces a new ticket priority or document status before the SDK adds that enum value can cause deserialization failure. Treat enum additions as a compatibility event and update the SDK promptly.

Route growth

EndpointCoverageTests compares the pinned OpenAPI method/path set with EndpointCatalog.All. A new route makes the test fail until a typed SDK method is added. The low-level request API can be used temporarily for a compatible deployment extension, but it is not a substitute for updating the typed surface.

Version path

The current contract uses /api/v1. The SDK appends that path only when the configured deployment URL does not already end with it. A future major API path should be represented by an SDK major-version/configuration decision rather than silently guessed.