kibana/api_docs/kbn_openapi_bundler.devdocs.json

{
  "id": "@kbn/openapi-bundler",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/openapi-bundler",
        "id": "def-common.bundle",
        "type": "Function",
        "tags": [],
        "label": "bundle",
        "description": [],
        "signature": [
          "({ sourceGlob, outputFilePath, options, }: ",
          {
            "pluginId": "@kbn/openapi-bundler",
            "scope": "common",
            "docId": "kibKbnOpenapiBundlerPluginApi",
            "section": "def-common.BundlerConfig",
            "text": "BundlerConfig"
          },
          ") => Promise<void>"
        ],
        "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_bundler.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.bundle.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  sourceGlob,\n  outputFilePath = 'bundled_{version}.schema.yaml',\n  options,\n}",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/openapi-bundler",
                "scope": "common",
                "docId": "kibKbnOpenapiBundlerPluginApi",
                "section": "def-common.BundlerConfig",
                "text": "BundlerConfig"
              }
            ],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_bundler.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/openapi-bundler",
        "id": "def-common.merge",
        "type": "Function",
        "tags": [],
        "label": "merge",
        "description": [],
        "signature": [
          "({ sourceGlobs, outputFilePath, options, }: ",
          {
            "pluginId": "@kbn/openapi-bundler",
            "scope": "common",
            "docId": "kibKbnOpenapiBundlerPluginApi",
            "section": "def-common.MergerConfig",
            "text": "MergerConfig"
          },
          ") => Promise<void>"
        ],
        "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_merger.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.merge.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  sourceGlobs,\n  outputFilePath = 'merged.schema.yaml',\n  options,\n}",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/openapi-bundler",
                "scope": "common",
                "docId": "kibKbnOpenapiBundlerPluginApi",
                "section": "def-common.MergerConfig",
                "text": "MergerConfig"
              }
            ],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_merger.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/openapi-bundler",
        "id": "def-common.BundlerConfig",
        "type": "Interface",
        "tags": [],
        "label": "BundlerConfig",
        "description": [],
        "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_bundler.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.BundlerConfig.sourceGlob",
            "type": "string",
            "tags": [],
            "label": "sourceGlob",
            "description": [],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_bundler.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.BundlerConfig.outputFilePath",
            "type": "string",
            "tags": [],
            "label": "outputFilePath",
            "description": [],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_bundler.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.BundlerConfig.options",
            "type": "Object",
            "tags": [],
            "label": "options",
            "description": [],
            "signature": [
              "BundleOptions | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_bundler.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/openapi-bundler",
        "id": "def-common.MergerConfig",
        "type": "Interface",
        "tags": [],
        "label": "MergerConfig",
        "description": [],
        "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_merger.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.MergerConfig.sourceGlobs",
            "type": "Array",
            "tags": [],
            "label": "sourceGlobs",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_merger.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.MergerConfig.outputFilePath",
            "type": "string",
            "tags": [],
            "label": "outputFilePath",
            "description": [],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_merger.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/openapi-bundler",
            "id": "def-common.MergerConfig.options",
            "type": "Object",
            "tags": [],
            "label": "options",
            "description": [],
            "signature": [
              "MergerOptions | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-openapi-bundler/src/openapi_merger.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}