# Validate a documentation definition

**POST /validations**

Validate a definition against its schema (OpenAPI or AsyncAPI) and return errors without creating a new version. This is useful in a CI process, to validate that a changed definition file is valid and won't fail when being deployed on Bump.sh.



## Servers
- https://bump.sh/api/v1: https://bump.sh/api/v1 ()


## Authentication methods
- Authorization token
- Basic token


## Parameters



## Body parameters
Content-type: application/json
The version validation request object
- **documentation** (string)
  UUID or slug of the documentation.
- **hub** (string)
  UUID or slug of the hub if the documentation is part of a hub.
- **documentation_name** (string)
  Name of the documentation to create. Used only if `auto_create_documentation` is set.
- **auto_create_documentation** (boolean)
  Create the documentation if it does not exist yet. Must be used with a `hub` and a `documentation`.
- **definition** (string)
  <small>==**REQUIRED**==</small> if `url` is not present.

Serialized definition. This should be an OpenAPI 2.x, 3.x
or AsyncAPI 2.x file serialized as a string, in YAML or
JSON.

- **references** (array[object])
  Import external references used by `definition`. It's usually resources not accessible by Bump.sh servers, like local files or internal URLs.
- **url** (string(uri))
  <small>==**REQUIRED**==</small> if `definition` is not present.

Target definition URL. It should be accessible through
HTTP by Bump.sh servers.


## Responses
### 200: Success

#### Body Parameters: application/json (object)
- **specification** (string)
  Specification of the given definition as a path: `speficiation_name/specification_version/format`.

### 400: Bad request

#### Body Parameters: application/json (object)
- **message** (string)
  Human readable error message for status 400.

### 422: Definition is not valid.

#### Body Parameters: application/json (object)
- **message** (string)
  Human readable error message.
- **errors** (object)
  Hash of invalid attributes with their error messages.


[Powered by Bump.sh](https://bump.sh)