Version deployed on Nov 6, 2017.

Bump Api

This is the official Bump API documentation. Obviously created with Bump. Note that this is an experimental API on which everything could change.

This is the documentation for version 1.0 of the API. Last update on Nov 6, 2017.

Base URL
https://bump.sh/api/v1

Authentication

Api token authentication

Use your token from your documentation settings to authenticate your requests. This token should be sent as a Authorization header.

Example: Authorization: Token YOU_TOKEN_VALUE


Versions

Create a new version

Create a new version for a given API, which will become the current version. Updated API is defined through the authentication.

Body
  • format string

    Format of the definition. Accepted values are json and yaml.

  • definition Required / string

    Definition of the version. Currently, only OpenApi 2.0 specification is supported. Can be sent as a JSON string or a YAML one.

Responses
  • 204

    No content

  • default object

    Unexpected error

    • message string

      Human readable error message

Definition
POST https://bump.sh/api/v1/api/versions
Example request
$ curl \ -X POST https://bump.sh/api/v1/api/versions \ -H "Content-Type: application/json" \ -d '{"format":"string","definition":"string"}'
Example response (204)
No content
Example response (default)
{ "message": "string" }

Doc

Create a new version

Create a new version for a given documentation, which will become the current version. Updated doc is defined through the authentication.

Body
  • format string

    Format of the definition. Accepted values are json and yaml.

  • definition Required / string

    Definition of the version. Currently, only OpenApi 2.0 specification is supported. Can be sent as a JSON string or a YAML one.

Responses
  • 204

    No content

  • default object

    Unexpected error

    • message string

      Human readable error message

Definition
POST https://bump.sh/api/v1/doc/versions
Example request
$ curl \ -X POST https://bump.sh/api/v1/doc/versions \ -H "Content-Type: application/json" \ -d '{"format":"string","definition":"string"}'
Example response (204)
No content
Example response (default)
{ "message": "string" }