json.schema.entity.teams.teamHierarchy.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/entity/teams/teamHierarchy.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Team Hierarchy",
  "description": "This schema defines the Team entity with Hierarchy. Hierarchical teams are supported `Organization` -> `BusinessUnit` -> `Division` -> `Department` -> `Group`.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.teams.TeamHierarchy",
  "definitions": {
    "teamHierarchyList": {
      "type": "array",
      "items": {
        "$ref": "teamHierarchy.json"
      },
      "default": null
    }
  },
  "properties": {
    "id": {
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "teamType": {
      "description": "Team type",
      "$ref": "team.json#/definitions/teamType"
    },
    "name": {
      "description": "A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "description": {
      "description": "Description of the team.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "fullyQualifiedName": {
      "description": "FullyQualifiedName same as `name`.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Name used for display purposes. Example 'Data Science team'.",
      "type": "string"
    },
    "href": {
      "description": "Link to the resource corresponding to this entity.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "children" : {
      "excludedFromEqualsAndHashCode": true,
      "description" : "Children teams. An `Organization` can have `BusinessUnit`, `Division` or `Department` as children. A `BusinessUnit` can have `BusinessUnit`, `Division`, or `Department` as children. A `Division` can have `Division` or `Department` as children. A `Department` can have `Department` as children.",
      "$ref" : "#/definitions/teamHierarchyList"
    },
    "isJoinable": {
      "description": "Can any user join this team during sign up? Value of true indicates yes, and false no.",
      "type": "boolean",
      "default": true
    }
  },
  "required": ["id", "name"],
  "additionalProperties": false
}