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. The value can be added either in the request or the response.
  • Relaxing some of the constraints on an existing request parameter. For example, making it optional.
  • Adding a new response parameter to the API response.
  • Changing the format of opaque string identifiers.

In simple terms, all these rules mean:

  • 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 to existing APIs and relax constraints on existing request parameters at any time.