kibana/api_docs/kbn_router_to_openapispec.devdocs.json

{
  "id": "@kbn/router-to-openapispec",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/router-to-openapispec",
        "id": "def-server.generateOpenApiDocument",
        "type": "Function",
        "tags": [],
        "label": "generateOpenApiDocument",
        "description": [],
        "signature": [
          "(appRouters: { routers: ",
          "Router",
          "<",
          "RequestHandlerContextBase",
          ">[]; versionedRouters: ",
          "CoreVersionedRouter",
          "[]; }, opts: ",
          "GenerateOpenApiDocumentOptions",
          ") => Promise<",
          "OpenAPIV3",
          ".Document<{}>>"
        ],
        "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/router-to-openapispec",
            "id": "def-server.generateOpenApiDocument.$1",
            "type": "Object",
            "tags": [],
            "label": "appRouters",
            "description": [],
            "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/router-to-openapispec",
                "id": "def-server.generateOpenApiDocument.$1.routers",
                "type": "Array",
                "tags": [],
                "label": "routers",
                "description": [],
                "signature": [
                  "Router",
                  "<",
                  "RequestHandlerContextBase",
                  ">[]"
                ],
                "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/router-to-openapispec",
                "id": "def-server.generateOpenApiDocument.$1.versionedRouters",
                "type": "Array",
                "tags": [],
                "label": "versionedRouters",
                "description": [],
                "signature": [
                  "CoreVersionedRouter",
                  "[]"
                ],
                "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          },
          {
            "parentPluginId": "@kbn/router-to-openapispec",
            "id": "def-server.generateOpenApiDocument.$2",
            "type": "Object",
            "tags": [],
            "label": "opts",
            "description": [],
            "signature": [
              "GenerateOpenApiDocumentOptions"
            ],
            "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/router-to-openapispec",
        "id": "def-server.GenerateOpenApiDocumentOptionsFilters",
        "type": "Interface",
        "tags": [],
        "label": "GenerateOpenApiDocumentOptionsFilters",
        "description": [],
        "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/router-to-openapispec",
            "id": "def-server.GenerateOpenApiDocumentOptionsFilters.pathStartsWith",
            "type": "Array",
            "tags": [],
            "label": "pathStartsWith",
            "description": [],
            "signature": [
              "string[] | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/router-to-openapispec",
            "id": "def-server.GenerateOpenApiDocumentOptionsFilters.excludePathsMatching",
            "type": "Array",
            "tags": [],
            "label": "excludePathsMatching",
            "description": [],
            "signature": [
              "string[] | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/router-to-openapispec",
            "id": "def-server.GenerateOpenApiDocumentOptionsFilters.access",
            "type": "CompoundType",
            "tags": [
              "default"
            ],
            "label": "access",
            "description": [],
            "signature": [
              "\"public\" | \"internal\""
            ],
            "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/router-to-openapispec",
            "id": "def-server.GenerateOpenApiDocumentOptionsFilters.version",
            "type": "string",
            "tags": [
              "default"
            ],
            "label": "version",
            "description": [
              "\nWe generate spec for one version at a time"
            ],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-router-to-openapispec/src/generate_oas.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}