json.schema.api.tests.createTestSuite.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/api/data/createTestSuite.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateTestSuiteRequest",
  "description": "Schema corresponding to a Test Suite",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.tests.CreateTestSuite",
  "javaInterfaces": [
    "org.openmetadata.schema.CreateEntity"
  ],
  "definitions": {
    "testSuiteEntityName": {
      "description": "Name of a test suite entity. For executable testSuite, this should match the entity FQN in the platform.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    }
  },
  "properties": {
    "name": {
      "description": "Name that identifies this test suite.",
      "$ref": "#/definitions/testSuiteEntityName"
    },
    "displayName": {
      "description": "Display Name that identifies this test suite.",
      "type": "string"
    },
    "description": {
      "description": "Description of the test suite.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "owners": {
      "description": "Owners of this test suite",
      "$ref": "../../type/entityReferenceList.json"
    },
    "executableEntityReference": {
      "description": "FQN of the entity the test suite is executed against. Only applicable for executable test suites.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "domain": {
      "description": "Fully qualified name of the domain the Table belongs to.",
      "type": "string"
    },
    "tags": {
      "description": "Tags for this TestSuite",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}