Test Cases · JSON Structure

Test Cases Test Suite Structure

A collection of related test cases grouped together for organizational, execution, or reporting purposes.

Type: object Properties: 11 Required: 2

API TestingAutomationQuality AssuranceSoftware DevelopmentSoftware TestingTesting

TestSuite is a JSON Structure definition published by Test Cases, describing 11 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description project_id parent_suite_id test_case_ids tags created_by created_at updated_at total_test_cases

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/test-cases/refs/heads/main/json-structure/test-cases-test-suite-structure.json",
  "name": "TestSuite",
  "description": "A collection of related test cases grouped together for organizational, execution, or reporting purposes.",
  "properties": {
    "id": {
      "description": "Unique identifier for the test suite.",
      "type": "string"
    },
    "name": {
      "description": "Name of the test suite.",
      "type": "string"
    },
    "description": {
      "description": "Description of what the test suite covers and its purpose.",
      "type": "string"
    },
    "project_id": {
      "description": "Identifier of the project this suite belongs to.",
      "type": "string"
    },
    "parent_suite_id": {
      "description": "Identifier of the parent test suite for nested suite hierarchies.",
      "type": "string"
    },
    "test_case_ids": {
      "items": {
        "type": "string"
      },
      "description": "Ordered list of test case identifiers included in this suite.",
      "type": "array"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "description": "Labels for filtering and organizing test suites.",
      "type": "array"
    },
    "created_by": {
      "description": "Username of the person who created the test suite.",
      "type": "string"
    },
    "created_at": {
      "description": "ISO 8601 timestamp when the suite was created.",
      "type": "datetime"
    },
    "updated_at": {
      "description": "ISO 8601 timestamp when the suite was last modified.",
      "type": "datetime"
    },
    "total_test_cases": {
      "minimum": 0,
      "description": "Total number of test cases in this suite including nested suites.",
      "type": "int32"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}