json.schema.api.tests.createTestDefinition.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/createTestDefinition.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateTestDefinitionRequest",
  "description": "Schema corresponding to a Test Definition",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.tests.CreateTestDefinition",
  "javaInterfaces": ["org.openmetadata.schema.CreateEntity"],
  "properties": {
    "name": {
      "description": "Name that identifies this test case.",
      "$ref": "../../type/basic.json#/definitions/testCaseEntityName"
    },
    "displayName": {
      "description": "Display Name that identifies this test case.",
      "type": "string"
    },
    "description": {
      "description": "Description of the testcase.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "owners": {
      "description": "Owners of this TestCase definition.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "entityType": {
      "$ref": "../../tests/testDefinition.json#/definitions/entityType"
    },
    "testPlatforms": {
      "type": "array",
      "items": {
        "$ref": "../../tests/testDefinition.json#/definitions/testPlatform"
      }
    },
    "supportedDataTypes": {
      "type": "array",
      "items": {
        "$ref": "../../entity/data/table.json#/definitions/dataType"
      }
    },
    "provider" : {
      "$ref": "../../type/basic.json#/definitions/providerType"
    },
    "parameterDefinition": {
      "type": "array",
      "items": {
        "$ref": "../../tests/testDefinition.json#/definitions/testCaseParameterDefinition"
      }
    },
    "domain" : {
      "description": "Fully qualified name of the domain the Table belongs to.",
      "type": "string"
    }
  },
  "required": ["name", "description","entityType", "testPlatforms"],
  "additionalProperties": false
}