Bump.sh · Example Payload

Bump Sh Validate Example

API ChangelogAPI DocumentationAPI HubAPI GovernanceArazzoAsyncAPICI/CDFlowerMCPOpenAPIWorkflows

Bump Sh Validate 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 /validations",
  "operationId": "validate",
  "summary": "Validate a Documentation Definition",
  "request": {
    "method": "POST",
    "url": "https://bump.sh/api/v1/validations",
    "headers": {
      "Authorization": "Token {documentation_token}",
      "Content-Type": "application/json",
      "Accept": "application/json"
    },
    "body": {
      "documentation": "my-api",
      "definition": "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"My API\",\"version\":\"2.0.0\"},\"paths\":{}}"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "specification": "openapi/3.1.0",
      "valid": true,
      "errors": []
    }
  }
}