json.schema.api.services.createApiService.json Maven / Gradle / Ivy
{
"$id": "https://open-metadata.org/schema/api/services/createAPIService.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "CreateApiServiceRequest",
"description": "Create API Service entity request",
"type": "object",
"javaType": "org.openmetadata.schema.api.services.CreateAPIService",
"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 API service. It could be title or label from the source services.",
"type": "string"
},
"description": {
"description": "Description of API service entity.",
"$ref": "../../type/basic.json#/definitions/markdown"
},
"serviceType": {
"$ref": "../../entity/services/apiService.json#/definitions/apiServiceType"
},
"connection": {
"$ref": "../../entity/services/apiService.json#/definitions/apiServiceConnection"
},
"tags": {
"description": "Tags for this API Service.",
"type": "array",
"items": {
"$ref": "../../type/tagLabel.json"
},
"default": null
},
"owners": {
"description": "Owners of this API 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 API Service belongs to.",
"type": "string"
}
},
"required": ["name", "serviceType"],
"additionalProperties": false
}