/v1/validate

Validation
POST <baseUrl>/v1/validate

POST Validate an OpenAPI specification from base64 or URL input

Submit an OpenAPI specification for validation. The specification can be provided either as a base64-encoded string or as a URL to a publicly accessible specification file.

Request Body

Required
application/json
Schema: SubmitRequestData
base64 - Base64 encoded spec 
{
  "Data": "ewogICJvcGVuYXBpIjogIjMuMC4wIiwKICAiaW5mbyI6IHsKICAgICJ0aXRsZSI6ICJTYW1wbGUgQVBJIiwKICAgICJ2ZXJzaW9uIjogIjEuMC4wIgogIH0KfQ==",
  "Type": "base64"
}
url - URL to OpenAPI spec 
{
  "Data": "https://petstore.swagger.io/v2/swagger.json",
  "Type": "url"
}

Responses

200 Validation completed successfully
application/json
Schema: ValidationResponse
success - Successful validation 
{
  "issues": [],
  "result": "PASSED"
}
withIssues - Validation with issues 
{
  "issues": [
    {
      "message": "Required property 'paths' is missing",
      "path": "/",
      "severity": "ERROR"
    }
  ],
  "result": "FAILED"
}
400 Invalid request
application/json
Schema: ErrorResponse 
{
  "detail": "Could not decode base64 data",
  "error": "Invalid input format"
}
401 Unauthorized
500 Internal server error

Security

  • apiKeyAuth [apiKey]
    API Key authentication. Use the X-API-KEY header (generated from the Vaktum portal) to authenticate directly to a workspace.
    In: header
    Name: X-API-KEY
  • bearerAuth [http]
    OAuth2 authentication. Use the Authorization header with a Bearer token. Also provide X-WORKSPACE-ID header for workspace context.
    Scheme: bearer
    Bearer Format: JWT