{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-devops/json-schema/microsoft-azure-devops-test-suite-schema.json",
  "title": "TestSuite",
  "description": "A test suite within a test plan",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-devops-test-suites-api-openapi.yml#/components/schemas/TestSuite",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique numeric identifier of the test suite"
    },
    "name": {
      "type": "string",
      "description": "Display name of the test suite"
    },
    "suiteType": {
      "type": "string",
      "description": "Type of test suite",
      "enum": [
        "none",
        "dynamicTestSuite",
        "staticTestSuite",
        "requirementTestSuite"
      ]
    },
    "planId": {
      "type": "integer",
      "description": "ID of the test plan this suite belongs to"
    },
    "children": {
      "type": "array",
      "description": "Child test suites (if requested via expand)",
      "items": {
        "$ref": "#/$defs/TestSuite"
      }
    },
    "defaultTesters": {
      "type": "array",
      "description": "Default testers assigned to test cases in this suite",
      "items": {
        "$ref": "#/$defs/IdentityRef"
      }
    },
    "parentSuite": {
      "$ref": "#/$defs/TestSuiteReference"
    },
    "requirementId": {
      "type": "integer",
      "description": "Work item ID this suite is linked to (for requirement suites)"
    },
    "queryString": {
      "type": "string",
      "description": "WIQL query for dynamic suites"
    },
    "state": {
      "type": "string",
      "description": "Suite state",
      "enum": [
        "inProgress",
        "completed"
      ]
    },
    "testCaseCount": {
      "type": "integer",
      "description": "Number of test cases in this suite"
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether this suite is active"
    },
    "lastUpdatedBy": {
      "$ref": "#/$defs/IdentityRef"
    },
    "lastUpdatedDate": {
      "type": "string",
      "format": "date-time"
    },
    "project": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "_links": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  },
  "$defs": {
    "IdentityRef": {
      "type": "object",
      "description": "Reference to an Azure DevOps user identity",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "displayName": {
          "type": "string"
        },
        "uniqueName": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "imageUrl": {
          "type": "string",
          "format": "uri"
        },
        "descriptor": {
          "type": "string"
        }
      }
    },
    "TestSuite": {
      "type": "object",
      "description": "A test suite within a test plan",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique numeric identifier of the test suite"
        },
        "name": {
          "type": "string",
          "description": "Display name of the test suite"
        },
        "suiteType": {
          "type": "string",
          "description": "Type of test suite",
          "enum": [
            "none",
            "dynamicTestSuite",
            "staticTestSuite",
            "requirementTestSuite"
          ]
        },
        "planId": {
          "type": "integer",
          "description": "ID of the test plan this suite belongs to"
        },
        "children": {
          "type": "array",
          "description": "Child test suites (if requested via expand)",
          "items": {
            "$ref": "#/$defs/TestSuite"
          }
        },
        "defaultTesters": {
          "type": "array",
          "description": "Default testers assigned to test cases in this suite",
          "items": {
            "$ref": "#/$defs/IdentityRef"
          }
        },
        "parentSuite": {
          "$ref": "#/$defs/TestSuiteReference"
        },
        "requirementId": {
          "type": "integer",
          "description": "Work item ID this suite is linked to (for requirement suites)"
        },
        "queryString": {
          "type": "string",
          "description": "WIQL query for dynamic suites"
        },
        "state": {
          "type": "string",
          "description": "Suite state",
          "enum": [
            "inProgress",
            "completed"
          ]
        },
        "testCaseCount": {
          "type": "integer",
          "description": "Number of test cases in this suite"
        },
        "isActive": {
          "type": "boolean",
          "description": "Whether this suite is active"
        },
        "lastUpdatedBy": {
          "$ref": "#/$defs/IdentityRef"
        },
        "lastUpdatedDate": {
          "type": "string",
          "format": "date-time"
        },
        "project": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "_links": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        }
      }
    },
    "TestSuiteReference": {
      "type": "object",
      "description": "Minimal reference to a test suite",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      }
    }
  }
}