Test Specifications · JSON Structure

Test Specifications Structure

Structural documentation for API test specification documents.

Type: object Properties: 0
Acceptance TestingContract TestingDocumentationOpenAPIQuality AssuranceTesting

Test Specifications Structure is a JSON Structure definition published by Test Specifications.

Meta-schema:

JSON Structure

test-specifications-structure.json Raw ↑
{
  "title": "Test Specification Structure",
  "description": "Structural documentation for API test specification documents.",
  "type": "object",
  "fields": [
    { "name": "id", "type": "string", "required": true },
    { "name": "name", "type": "string", "required": true },
    { "name": "version", "type": "string", "required": true },
    { "name": "description", "type": "string", "required": false },
    {
      "name": "scope",
      "type": "object",
      "required": true,
      "description": "The API or system this specification covers.",
      "fields": [
        { "name": "name", "type": "string", "required": true },
        { "name": "version", "type": "string", "required": false },
        { "name": "specificationUrl", "type": "string", "format": "uri", "required": false }
      ]
    },
    {
      "name": "format",
      "type": "string",
      "required": false,
      "enum": ["openapi", "asyncapi", "json-schema", "gherkin", "pact", "hurl", "custom"]
    },
    {
      "name": "testCases",
      "type": "array",
      "required": false,
      "items": {
        "type": "object",
        "fields": [
          { "name": "id", "type": "string", "required": true },
          { "name": "name", "type": "string", "required": true },
          { "name": "description", "type": "string", "required": false },
          { "name": "given", "type": "object", "required": true },
          { "name": "expected", "type": "object", "required": true },
          { "name": "priority", "type": "string", "required": false },
          { "name": "tags", "type": "array", "required": false }
        ]
      }
    },
    { "name": "conformanceLevels", "type": "array", "required": false },
    { "name": "tags", "type": "array", "required": false },
    { "name": "created", "type": "string", "format": "date", "required": false },
    { "name": "modified", "type": "string", "format": "date", "required": false }
  ]
}