Skip to content

Commit

Permalink
update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stacey-gammon committed May 20, 2021
1 parent ca2332d commit 028a6d8
Show file tree
Hide file tree
Showing 41 changed files with 32,998 additions and 19,344 deletions.
79 changes: 66 additions & 13 deletions api_docs/alerting.json
Original file line number Diff line number Diff line change
Expand Up @@ -1105,7 +1105,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
"lineNumber": 132
"lineNumber": 140
},
"deprecated": false,
"children": [
Expand All @@ -1118,7 +1118,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
"lineNumber": 133
"lineNumber": 141
},
"deprecated": false
},
Expand All @@ -1131,7 +1131,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
"lineNumber": 134
"lineNumber": 142
},
"deprecated": false
},
Expand All @@ -1144,7 +1144,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
"lineNumber": 135
"lineNumber": 143
},
"deprecated": false
},
Expand All @@ -1168,7 +1168,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
"lineNumber": 136
"lineNumber": 144
},
"deprecated": false
}
Expand All @@ -1184,7 +1184,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 84
"lineNumber": 85
},
"deprecated": false,
"children": [
Expand All @@ -1208,7 +1208,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 85
"lineNumber": 86
},
"deprecated": false,
"children": [
Expand All @@ -1231,7 +1231,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 93
"lineNumber": 94
},
"deprecated": false,
"isRequired": true
Expand All @@ -1251,7 +1251,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 104
"lineNumber": 105
},
"deprecated": false,
"children": [
Expand All @@ -1269,7 +1269,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 105
"lineNumber": 106
},
"deprecated": false,
"returnComment": [],
Expand Down Expand Up @@ -1303,7 +1303,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 106
"lineNumber": 107
},
"deprecated": false,
"children": [
Expand All @@ -1326,7 +1326,60 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 106
"lineNumber": 107
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "alerting",
"id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest",
"type": "Function",
"tags": [],
"label": "getAlertingAuthorizationWithRequest",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Pick<",
"AlertingAuthorization",
", \"ensureAuthorized\" | \"getFindAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">"
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 108
},
"deprecated": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 109
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -1354,7 +1407,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 107
"lineNumber": 111
},
"deprecated": false,
"returnComment": [],
Expand Down
16 changes: 6 additions & 10 deletions api_docs/apm.json
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 269
"lineNumber": 270
},
"deprecated": false,
"children": [
Expand All @@ -331,7 +331,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 269
"lineNumber": 270
},
"deprecated": false,
"isRequired": true
Expand All @@ -351,7 +351,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 288
"lineNumber": 289
},
"deprecated": false,
"children": [],
Expand Down Expand Up @@ -1480,18 +1480,14 @@
"<\"GET /api/apm/observability_overview/has_rum_data\", ",
"PartialC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"PartialC",
"<{ uiFilters: ",
"StringC",
"; }>, ",
"TypeC",
"<{ start: ",
"; start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>]>; }>, ",
"<number, string, unknown>; }>; }>, ",
{
"pluginId": "apm",
"scope": "server",
Expand Down
Loading

0 comments on commit 028a6d8

Please sign in to comment.