/v1/api/{apiId}/test-suite-generate

Validation
OPTIONS <baseUrl>/v1/api/{apiId}/test-suite-generate

OPTIONS Options for test suite generation

Responses

200 Options successful. Returns allowed HTTP methods.

POST Generate Test Suite

Automatically generate a test suite for the specified API based on its specification.

Request Body

Optional
application/json
{
  "type": "object"
}

Responses

201 Test suite generated successfully.
application/json
Type: [object] 
{
  "properties": {
    "apiId": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "notes": {
      "type": "string"
    },
    "specificationId": {
      "type": "string"
    },
    "tests": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
400 Invalid request
401 Unauthorized
500 Failed to generate test suite

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