kibana/api_docs/snapshot_restore.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733)
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

372 lines
10 KiB
JSON

{
"id": "snapshotRestore",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [
{
"id": "def-common.REPOSITORY_TYPES",
"type": "Enum",
"label": "REPOSITORY_TYPES",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 25
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-common.API_BASE_PATH",
"type": "string",
"label": "API_BASE_PATH",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 23
},
"signature": [
"\"/api/snapshot_restore/\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.APP_REQUIRED_CLUSTER_PRIVILEGES",
"type": "Array",
"label": "APP_REQUIRED_CLUSTER_PRIVILEGES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 55
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.APP_RESTORE_INDEX_PRIVILEGES",
"type": "Array",
"label": "APP_RESTORE_INDEX_PRIVILEGES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 59
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.APP_SLM_CLUSTER_PRIVILEGES",
"type": "Array",
"label": "APP_SLM_CLUSTER_PRIVILEGES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 60
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_REPOSITORY_TYPES",
"type": "Array",
"label": "DEFAULT_REPOSITORY_TYPES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 36
},
"signature": [
"RepositoryType",
"[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PLUGIN_REPOSITORY_TYPES",
"type": "Array",
"label": "PLUGIN_REPOSITORY_TYPES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 41
},
"signature": [
"RepositoryType",
"[]"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.PLUGIN",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PLUGIN.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-common.PLUGIN.minimumLicenseType",
"type": "string",
"label": "minimumLicenseType",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 15
},
"signature": [
"\"basic\""
]
},
{
"id": "def-common.PLUGIN.getI18nName",
"type": "Function",
"children": [
{
"id": "def-common.PLUGIN.getI18nName.$1",
"type": "Any",
"label": "i18n",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16
}
}
],
"signature": [
"(i18n: any) => string"
],
"description": [],
"label": "getI18nName",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "PLUGIN",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.REPOSITORY_PLUGINS_MAP",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorys3",
"type": "string",
"label": "'repository-s3'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 49
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".s3"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryhdfs",
"type": "string",
"label": "'repository-hdfs'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 50
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".hdfs"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryazure",
"type": "string",
"label": "'repository-azure'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 51
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".azure"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorygcs",
"type": "string",
"label": "'repository-gcs'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".gcs"
]
}
],
"description": [],
"label": "REPOSITORY_PLUGINS_MAP",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 48
},
"initialIsOpen": false
},
{
"id": "def-common.TIME_UNITS",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.TIME_UNITS.DAY",
"type": "string",
"label": "DAY",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 63
},
"signature": [
"\"d\""
]
},
{
"tags": [],
"id": "def-common.TIME_UNITS.HOUR",
"type": "string",
"label": "HOUR",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 64
},
"signature": [
"\"h\""
]
},
{
"tags": [],
"id": "def-common.TIME_UNITS.MINUTE",
"type": "string",
"label": "MINUTE",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 65
},
"signature": [
"\"m\""
]
},
{
"tags": [],
"id": "def-common.TIME_UNITS.SECOND",
"type": "string",
"label": "SECOND",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 66
},
"signature": [
"\"s\""
]
}
],
"description": [],
"label": "TIME_UNITS",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 62
},
"initialIsOpen": false
}
]
}
}