kibana/api_docs/workchat_framework.devdocs.json

{
  "id": "workchatFramework",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "workchatFramework",
      "id": "def-public.WorkChatFrameworkPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "WorkChatFrameworkPluginSetup",
      "description": [],
      "path": "x-pack/solutions/chat/plugins/workchat-framework/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "workchatFramework",
      "id": "def-public.WorkChatFrameworkPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "WorkChatFrameworkPluginStart",
      "description": [],
      "path": "x-pack/solutions/chat/plugins/workchat-framework/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "workchatFramework",
      "id": "def-server.WorkChatFrameworkPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "WorkChatFrameworkPluginSetup",
      "description": [
        "\nSetup contract for the workchatFramework plugin."
      ],
      "path": "x-pack/solutions/chat/plugins/workchat-framework/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "workchatFramework",
          "id": "def-server.WorkChatFrameworkPluginSetup.tools",
          "type": "Object",
          "tags": [],
          "label": "tools",
          "description": [
            "\nAPIs to interact with tool registration."
          ],
          "signature": [
            "{ register: (definition: ",
            {
              "pluginId": "@kbn/wc-framework-types-server",
              "scope": "common",
              "docId": "kibKbnWcFrameworkTypesServerPluginApi",
              "section": "def-common.Tool",
              "text": "Tool"
            },
            "<Zod.ZodRawShape, unknown>) => void; }"
          ],
          "path": "x-pack/solutions/chat/plugins/workchat-framework/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "workchatFramework",
          "id": "def-server.WorkChatFrameworkPluginSetup.workflows",
          "type": "Object",
          "tags": [],
          "label": "workflows",
          "description": [
            "\nAPIs to interact with workflow registration."
          ],
          "signature": [
            "{ register: (definition: ",
            {
              "pluginId": "@kbn/wc-framework-types-server",
              "scope": "common",
              "docId": "kibKbnWcFrameworkTypesServerPluginApi",
              "section": "def-common.WorkflowDefinition",
              "text": "WorkflowDefinition"
            },
            ") => void; }"
          ],
          "path": "x-pack/solutions/chat/plugins/workchat-framework/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "workchatFramework",
      "id": "def-server.WorkChatFrameworkPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "WorkChatFrameworkPluginStart",
      "description": [
        "\nStart contract for the workchatFramework plugin."
      ],
      "path": "x-pack/solutions/chat/plugins/workchat-framework/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "workchatFramework",
          "id": "def-server.WorkChatFrameworkPluginStart.workflows",
          "type": "Object",
          "tags": [],
          "label": "workflows",
          "description": [
            "\nAPIs to interact with workflow execution"
          ],
          "signature": [
            "{ run: (options: ",
            {
              "pluginId": "@kbn/wc-framework-types-server",
              "scope": "common",
              "docId": "kibKbnWcFrameworkTypesServerPluginApi",
              "section": "def-common.RunWorkflowParams",
              "text": "RunWorkflowParams"
            },
            "<Record<string, unknown>>) => Promise<",
            {
              "pluginId": "@kbn/wc-framework-types-server",
              "scope": "common",
              "docId": "kibKbnWcFrameworkTypesServerPluginApi",
              "section": "def-common.RunWorkflowOutput",
              "text": "RunWorkflowOutput"
            },
            "<Record<string, unknown>>>; }"
          ],
          "path": "x-pack/solutions/chat/plugins/workchat-framework/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}