SDK Backward Compatibility

The following changes are considered backward-compatible:

  • Adding a new API resource or method.
  • Adding a new optional request parameter to an existing API method.
  • Adding a new Enum value (in either the request or the response).
  • Relaxing constraints on an existing request parameter (e.g., making it optional).
  • Adding a new response parameter to the API response.
  • Changing the format of opaque string identifiers.

In simple terms:

  • Ignore any unknown fields or Enum values received as part of API responses.
  • Do not make any assumptions except length about opaque string identifiers.
  • The Service Operator may add new optional parameters or relax constraints on existing parameters at any time.