Bump.sh · Example Payload

Bump Sh Create Version Example

API ChangelogAPI DocumentationAPI HubAPI GovernanceArazzoAsyncAPICI/CDFlowerMCPOpenAPIWorkflows

Bump Sh Create Version Example is an example object payload from Bump.sh, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationoperationIdsummaryrequestresponse

Example Payload

Raw ↑ 
{
  "operation": "POST /versions",
  "operationId": "createVersion",
  "summary": "Create a New Version",
  "request": {
    "method": "POST",
    "url": "https://bump.sh/api/v1/versions",
    "headers": {
      "Authorization": "Token {documentation_token}",
      "Content-Type": "application/json",
      "Accept": "application/json"
    },
    "body": {
      "documentation": "my-api",
      "hub": "platform-apis",
      "branch_name": "main",
      "definition": "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"My API\",\"version\":\"2.0.0\"},\"paths\":{}}",
      "auto_create_documentation": true
    }
  },
  "response": {
    "status": 201,
    "body": {
      "id": "deadbeef-1234-5678-9abc-deadbeefcafe",
      "doc_id": "11111111-aaaa-bbbb-cccc-dddddddddddd",
      "doc_public_url": "https://bump.sh/platform-apis/doc/my-api",
      "diff_summary": "5 endpoints added, 2 modified",
      "diff_url": "https://bump.sh/diffs/9b71f8e2-3c0c-4a59-9d2a-2c5e8e5f3f3d",
      "diff_breaking": false
    }
  }
}