For AI agents: a documentation index is available at https://developers.bump.sh/doc/workspace/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.

Do not miss any Bump.sh Workspace API changes, ever again

Subscribe to the Bump.sh Workspace API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
3 structure changes including:
3 Modifications
Modified 3
POST /previews
  • Body
  • content type Modified
    • references property Added
POST /validations
  • Body
  • content type Modified
    • references property Added
POST /versions
  • Body
  • content type Modified
    • references property Added
1 structure change including:
1 Addition
Added 1
GET /ping
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /validations
  • Body
  • content type Modified
    • auto_create_api property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • auto_create_documentation property Added
POST /versions
  • Body
  • content type Modified
    • auto_create_api property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • auto_create_documentation property Added
4 structure changes including:
2 Breaking changes
2 Additions
2 Removals
Removed 2 Breaking
POST /docs/{:id}/validations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /docs/{:id}/versions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /validations
POST /versions
3 structure changes including:
3 Modifications
Modified 3
POST /docs/{:id}/validations
  • Body
  • content type Modified
    • validation property Added
POST /docs/{:id}/versions
  • Body
  • content type Modified
    • validation property Added
POST /previews
  • Body
  • content type Modified
    • validation property Added
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /docs/{:id}/validations
  • Path
  • id path parameter Modified
  • Body
  • content type Modified
    • specification property Modified
      • Property is no longer required
  • Response
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /docs/{:id}/versions
  • Path
  • id path parameter Modified
  • Body
  • content type Modified
    • Content type is no longer required
    • specification property Modified
      • Property is no longer required
  • Response
  • 201, default responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /previews
  • Body
  • content type Modified
    • Content type is no longer required
    • specification property Modified
      • Property is no longer required
  • Response
  • 201, default responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /docs/{:id}/validations
  • Body
  • content type Modified
    • format property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • specification property Added
POST /docs/{:id}/versions
  • Body
  • content type Modified
    • format property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • specification property Added
POST /previews
  • Body
  • content type Modified
    • format property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • specification property Added
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /docs/{:id}/validations
  • Body
  • content type Modified
    • version property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • format, definition properties Added
  • Response
  • default response Modified
    • Full types is no longer object
      Breaking
    • errors, message properties Removed
POST /docs/{:id}/versions
  • Body
  • content type Modified
    • version property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • format, definition properties Added
  • Response
  • default response Modified
    • Full types is no longer object
      Breaking
    • errors, message properties Removed
POST /previews
  • Body
  • content type Modified
    • preview property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • format, definition properties Added
  • Response
  • default response Modified
    • Full types is no longer object
      Breaking
    • errors, message properties Removed
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /docs/{:id}/validations
  • Body
  • content type Modified
    • Content type is no longer required
    • format, definition properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • version property Added
POST /docs/{:id}/versions
  • Body
  • content type Modified
    • format, definition properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • version property Added
POST /previews
  • Body
  • content type Modified
    • format, definition properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • preview property Added
1 structure change including:
1 Modification
Modified 1
POST /previews
  • Response
  • 201 response Modified
    • Full types is now object
    • id, expires_at properties Added
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
POST /docs/{:id}/validations
  • Response
  • 422 response Modified
    • raw_definition property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • errors, message properties Added
  • default response Added
POST /docs/{:id}/versions
  • Response
  • default response Modified
    • errors property Added
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 422 responses Added
Added 1
POST /previews
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
POST /doc/versions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /docs/{:id}/validations
POST /docs/{:id}/versions
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
POST /api/versions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /doc/versions
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
POST /apis/{:api_id}/versions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /api/versions
1 structure change including:
1 Modification
Modified 1 Breaking
POST /apis/{:api_id}/versions
  • Body
  • content type Modified
    • definition property Modified
      • Property is now required
        Breaking