Skip to content

Upgrading

When adopting a new Okatana OpenAPI file:

  1. replace resources/openapi.yaml with the authoritative new file;
  2. run mvn test and inspect EndpointCoverageTest;
  3. diff request schemas, enums, statuses, and descriptions;
  4. add typed operations for new paths;
  5. update models only where new formal schemas exist;
  6. preserve omission/null behavior for PATCH fields;
  7. regenerate the endpoint matrix and OpenAPI contract reference;
  8. compile the example project;
  9. run mkdocs build --strict;
  10. update the SDK semantic version according to compatibility impact.

Avoid generating fields from undocumented observed responses and presenting them as contract guarantees. Use DynamicResource until the upstream schema is explicit.