json.schema.api.data.createLocation.json Maven / Gradle / Ivy

Go to download

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

The newest version!

{
  "$id": "https://open-metadata.org/schema/api/data/createLocation.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateLocationRequest",
  "description": "Create Location entity request",
  "type": "object",
  "javaType": "org.openmetadata.catalog.api.data.CreateLocation",
  "javaInterfaces": ["org.openmetadata.core.entity.interfaces.CreateEntity"],

  "properties": {
    "name": {
      "description": "Name that identifies this Location.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this location.",
      "type": "string"
    },
    "path": {
      "description": "Location full path.",
      "type": "string"
    },
    "description": {
      "description": "Description of the location instance.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "locationType": {
      "$ref": "../../entity/data/location.json#/definitions/locationType"
    },
    "tags": {
      "description": "Tags for this location",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },
    "owner": {
      "description": "Owner of this Location",
      "$ref": "../../type/entityReference.json"
    },
    "service": {
      "description": "Link to the pipeline service where this location is used",
      "$ref": "../../type/entityReference.json"
    }
  },
  "required": ["name", "service"],
  "additionalProperties": false
}