Skip to content

Changelog

Each entry is derived from the diff between two published contracts, so a line here is true by construction: a removed operation, a newly required field or a changed scope is listed as breaking and forces a major version of the SDK; an added operation is a minor; prose is a patch. The entries are proposed by the docs bot on a docs/auto/<date> branch and merged by a person.

SDK bump forced by the contract diff: minor.

  • GET /v1/catalogue/definitions: response shape changed
  • GET /v1/catalogue/definitions/{slug}: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
  • GET /v1/developers/admin/submissions/{versionId}: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
  • GET /v1/developers/admin/submissions: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
  • POST /v1/developers/submissions: request shape changed; response shape changed
  • GET /v1/developers/submissions/{versionId}: response shape changed
  • GET /v1/developers/submissions: response shape changed
  • PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed
  • POST /v1/developers/auth/change-password: description changed
  • POST /v1/developers/auth/mfa/disable: description changed
  • POST /v1/developers/auth/forgot-password: description changed
  • POST /v1/developers/auth/logout: description changed
  • POST /v1/developers/auth/refresh: description changed
  • POST /v1/developers/auth/reset-password: description changed
  • GET /v1/developers/admin/developers: description changed
  • GET /v1/developers/admin/quota-defaults: description changed
  • PUT /v1/developers/admin/developers/{developerId}/quota: description changed
  • GET /v1/developers/keys: description changed
  • GET /v1/developers/me: description changed
  • GET /v1/developers/quota: description changed
  • POST /v1/developers/keys/{keyId}/rotate: description changed
  • GET /v1/developers/usage: description changed
  • POST /v1/developers/admin/developers/{developerId}/verify: description changed
  • GET /v1/developers/webhooks/{id}/deliveries: description changed
  • POST /v1/developers/webhooks/{id}/enable: description changed
  • GET /v1/developers/webhooks: description changed
  • POST /v1/developers/webhooks/{id}/test: description changed
  • reviewQueue
  • webhooksRemove

SDK bump forced by the contract diff: minor.

  • POST /v1/developers/auth/mfa/disable: operation added
  • POST /v1/developers/auth/mfa/enable: operation added
  • POST /v1/developers/auth/mfa/setup: operation added
  • GET /v1/catalogue/definitions: response shape changed
  • GET /v1/catalogue/definitions/{slug}: response shape changed
  • POST /v1/developers/auth/login: request shape changed
  • GET /v1/developers/admin/developers: response shape changed
  • GET /v1/developers/me: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
  • GET /v1/developers/admin/submissions/{versionId}: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
  • GET /v1/developers/admin/submissions: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
  • POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
  • POST /v1/developers/submissions: request shape changed; response shape changed
  • GET /v1/developers/submissions/{versionId}: response shape changed
  • GET /v1/developers/submissions: response shape changed
  • PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed
  • catalogueDefinitions
  • catalogueOne
  • developerAuthChange
  • developerAuthDisableMfa
  • developerAuthForgot
  • developerAuthLogout
  • developerAuthRefresh
  • developerAuthReset
  • developersAdminList
  • developersAdminQuotaDefaults
  • developersAdminSetQuota
  • developersKeys
  • developersMe
  • developersQuota
  • developersRotate
  • developersUsage
  • reviewApprove
  • reviewDeprecate
  • reviewDetail
  • reviewReject
  • reviewRequestChanges
  • reviewVerify
  • submissionsGet
  • submissionsList
  • submissionsUpdate
  • webhooksDeliveries
  • webhooksEnable
  • webhooksList
  • webhooksTest

Drafts refused (named something not in the contract)

Section titled “Drafts refused (named something not in the contract)”
  • reviewQueue: versionId
  • webhooksRemove: events