maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/snapshot_restore.json
Stacey Gammon 2117e1324c
API DOCS Step 3/3 (#92929) (#93530) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	api_docs/core.json
#	api_docs/core_application.json
#	api_docs/core_http.json
#	api_docs/core_saved_objects.json
2021-03-03 20:12:24 -05:00

393 lines
13 KiB
JSON
Raw Blame History

{
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L25"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L23"
},
"signature": [
"\"/api/snapshot_restore/\""
],
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L36"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L41"
},
"signature": [
"RepositoryType",
"[]"
],
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L55"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L59"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L60"
},
"signature": [
"string[]"
],
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L14"
}
},
{
"tags": [],
"id": "def-common.PLUGIN.minimumLicenseType",
"type": "string",
"label": "minimumLicenseType",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L15"
},
"signature": [
"\"basic\""
]
},
{
"id": "def-common.PLUGIN.getI18nName",
"type": "Function",
"children": [
{
"type": "Any",
"label": "i18n",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L16"
}
}
],
"signature": [
"(i18n: any) => string"
],
"description": [],
"label": "getI18nName",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L16"
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "PLUGIN",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L13"
},
"initialIsOpen": false
},
{
"id": "def-common.REPOSITORY_PLUGINS_MAP",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-s3'",
"type": "string",
"label": "'repository-s3'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L49"
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".s3"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-hdfs'",
"type": "string",
"label": "'repository-hdfs'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L50"
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".hdfs"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-azure'",
"type": "string",
"label": "'repository-azure'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L51"
},
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".azure"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-gcs'",
"type": "string",
"label": "'repository-gcs'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L52"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L48"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L63"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L64"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L65"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L66"
},
"signature": [
"\"s\""
]
}
],
"description": [],
"label": "TIME_UNITS",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 62,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/snapshot_restore/common/constants.ts#L62"
},
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink