kibana/api_docs/cloud.json
Stacey Gammon cecdcc538e
API docs clean up (#93508)
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
2021-03-05 20:12:28 -05:00

234 lines
5.9 KiB
JSON

{
"id": "cloud",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.CloudConfigType",
"type": "Interface",
"label": "CloudConfigType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CloudConfigType.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.resetPasswordUrl",
"type": "string",
"label": "resetPasswordUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.deploymentUrl",
"type": "string",
"label": "deploymentUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.accountUrl",
"type": "string",
"label": "accountUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 20
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 16
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.CloudSetup",
"type": "Interface",
"label": "CloudSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CloudSetup.cloudId",
"type": "string",
"label": "cloudId",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 32
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.cloudDeploymentUrl",
"type": "string",
"label": "cloudDeploymentUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 33
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.isCloudEnabled",
"type": "boolean",
"label": "isCloudEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 34
}
},
{
"tags": [],
"id": "def-public.CloudSetup.resetPasswordUrl",
"type": "string",
"label": "resetPasswordUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 35
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.accountUrl",
"type": "string",
"label": "accountUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 36
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 31
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-server.CloudSetup",
"type": "Interface",
"label": "CloudSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.CloudSetup.cloudId",
"type": "string",
"label": "cloudId",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.CloudSetup.isCloudEnabled",
"type": "boolean",
"label": "isCloudEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-server.CloudSetup.apm",
"type": "Object",
"label": "apm",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 21
},
"signature": [
"{ url?: string | undefined; secretToken?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 18
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}