json.schema.api.services.createSearchService.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/services/createSearchService.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateSearchServiceRequest",
  "description": "Create Search Service entity request",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.services.CreateSearchService",
  "javaInterfaces": ["org.openmetadata.schema.CreateEntity"],

  "properties": {
    "name": {
      "description": "Name that identifies the this entity instance uniquely",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this search service. It could be title or label from the source services.",
      "type": "string"
    },
    "description": {
      "description": "Description of search service entity.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "serviceType": {
      "$ref": "../../entity/services/searchService.json#/definitions/searchServiceType"
    },
    "connection": {
      "$ref": "../../entity/services/searchService.json#/definitions/searchConnection"
    },
    "tags": {
      "description": "Tags for this Search Service.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },
    "owners": {
      "description": "Owners of this search service.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "dataProducts" : {
      "description": "List of fully qualified names of data products this entity is part of.",
      "type": "array",
      "items" : {
        "$ref" : "../../type/basic.json#/definitions/fullyQualifiedEntityName"
      }
    },
    "domain" : {
      "description": "Fully qualified name of the domain the Search Service belongs to.",
      "type": "string"
    }
  },
  "required": ["name", "serviceType"],
  "additionalProperties": false
}