Versioning Policy

• Major Release: Involves newer response payload which may be completely different from previous versions. A major release can contain newer resources and endpoints.

• Minor Release: Involves backward-compatible changes that add new features or enhancements without breaking existing functionality. These changes are incremental and may include:

  • Adding new endpoints
  • Adding optional parameters
  • Documentation updates

  Minor releases are not explicitly defined but typically involve changes that do not substantively alter the API structure or format. Examples of minor changes include:

  • Adding new API resources, endpoints, or schemas
  • Adding new optional properties to existing schemas
  • Adding new optional request parameters to existing methods
  • Adding new security schemes or OAuth2 scopes
  • Adding new HTTP verbs (e.g., POST, PUT, DELETE) to existing API endpoints
  • Adding new content types in existing API endpoints
  • Adding new optional HTTP headers
  • Adding new enum values
  • Adding new HTTP error status codes
  • Adding or updating documentation keywords such as description, title, or tags
  • Adding new links in the links section
  • Changing the order of properties in existing responses