json.schema.api.feed.createThread.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/feed/createThread.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateThreadRequest",
  "description": "Create thread request",
  "type": "object",
  "definitions": {
    "createTaskDetails": {
      "javaType": "org.openmetadata.schema.api.CreateTaskDetails",
      "description": "Details about the task. This is only applicable if thread is of type task.",
      "type": "object",
      "properties": {
        "type": {
          "$ref": "../../entity/feed/thread.json#/definitions/taskType"
        },
        "assignees": {
          "description": "List of users or teams the task is assigned to",
          "$ref": "../../type/entityReferenceList.json"
        },
        "oldValue": {
          "description": "The value of old object for which the task is created.",
          "type": "string"
        },
        "suggestion": {
          "description": "The suggestion object for the task provided by the creator.",
          "type": "string"
        }
      },
      "required": ["assignees", "type"],
      "additionalProperties": false
    }
  },
  "properties": {
    "message": {
      "description": "Message",
      "type": "string"
    },
    "from": {
      "description": "Name of the User (regular user or bot) posting the message",
      "type": "string"
    },
    "addressedTo": {
      "description": "User or team this thread is addressed to in format <#E::{entities}::{entityName}::{field}::{fieldValue}.",
      "$ref": "../../type/basic.json#/definitions/entityLink"
    },
    "about": {
      "description": "Data asset about which this thread is created for with format <#E::{entities}::{entityType}::{field}::{fieldValue}",
      "$ref": "../../type/basic.json#/definitions/entityLink"
    },
    "type": {
      "$ref": "../../entity/feed/thread.json#/definitions/threadType"
    },
    "taskDetails": {
      "$ref": "#/definitions/createTaskDetails"
    },
    "announcementDetails": {
      "$ref": "../../entity/feed/thread.json#/definitions/announcementDetails"
    },
    "chatbotDetails": {
      "description": "Details about the Chatbot conversation. This is only applicable if thread is of type Chatbot.",
      "$ref": "../../entity/feed/thread.json#/definitions/chatbotDetails"
    }
  },
  "required": ["message", "from", "about"],
  "additionalProperties": false
}