Skip to content

Commit

Permalink
update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@stacey-gammon
stacey-gammon committed Jul 30, 2021
1 parent f2a5cd7 commit 70b8d81
Show file tree
Hide file tree
Showing 68 changed files with 11,964 additions and 7,175 deletions.
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import advancedSettingsObj from './advanced_settings.json';




Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for questions regarding this plugin.

**Code health stats**

Expand Down
44 changes: 22 additions & 22 deletions api_docs/alerting.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 76
"lineNumber": 78
},
"deprecated": false,
"children": [
Expand All @@ -305,7 +305,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 86
"lineNumber": 88
},
"deprecated": false,
"children": [
Expand All @@ -314,14 +314,14 @@
"id": "def-server.AlertingAuthorization.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n auditLogger,\n getSpace,\n exemptConsumerIds,\n }",
"label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n auditLogger,\n getSpace,\n getSpaceId,\n exemptConsumerIds,\n }",
"description": [],
"signature": [
"ConstructorOptions"
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 86
"lineNumber": 88
},
"deprecated": false,
"isRequired": true
Expand All @@ -337,11 +337,11 @@
"label": "getSpaceId",
"description": [],
"signature": [
"() => Promise<string | undefined>"
"() => string | undefined"
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 144
"lineNumber": 147
},
"deprecated": false,
"children": [],
Expand Down Expand Up @@ -385,7 +385,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 152
"lineNumber": 155
},
"deprecated": false,
"children": [
Expand All @@ -401,7 +401,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 153
"lineNumber": 156
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -434,7 +434,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 154
"lineNumber": 157
},
"deprecated": false,
"isRequired": true
Expand All @@ -457,7 +457,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 155
"lineNumber": 158
},
"deprecated": false,
"isRequired": true
Expand All @@ -479,7 +479,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 169
"lineNumber": 172
},
"deprecated": false,
"children": [
Expand All @@ -495,7 +495,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 169
"lineNumber": 172
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -529,7 +529,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 274
"lineNumber": 277
},
"deprecated": false,
"children": [
Expand All @@ -551,7 +551,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 275
"lineNumber": 278
},
"deprecated": false,
"isRequired": true
Expand All @@ -568,7 +568,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 276
"lineNumber": 279
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -616,7 +616,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 354
"lineNumber": 359
},
"deprecated": false,
"children": [
Expand All @@ -634,7 +634,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 355
"lineNumber": 360
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -667,7 +667,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 356
"lineNumber": 361
},
"deprecated": false,
"isRequired": true
Expand All @@ -690,7 +690,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 357
"lineNumber": 362
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -2006,7 +2006,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 24
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
Expand Down Expand Up @@ -2034,7 +2034,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 29
"lineNumber": 30
},
"deprecated": false,
"initialIsOpen": false
Expand All @@ -2048,7 +2048,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"lineNumber": 36
"lineNumber": 37
},
"deprecated": false,
"initialIsOpen": false
Expand Down
136 changes: 132 additions & 4 deletions api_docs/apm.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2207,17 +2207,33 @@
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>]>; }>, ",
"<number, string, unknown>; }>, ",
"PartialC",
"<{ offset: ",
"StringC",
"; }>]>; }>, ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMRouteHandlerResources",
"text": "APMRouteHandlerResources"
},
", { serviceDependencies: ",
"ServiceDependencyItem",
"[]; }, ",
", { serviceDependencies: { currentStats: { latency: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; throughput: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; errorRate: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; } & { impact: number; }; previousStats: ({ latency: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; throughput: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; errorRate: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; } & { impact: number; }) | null; location: ",
"Node",
"; }[]; }, ",
"APMRouteCreateOptions",
">; } & { \"GET /api/apm/services/{serviceName}/profiling/timeline\": ",
"ServerRoute",
Expand Down Expand Up @@ -3753,6 +3769,118 @@
},
"; }, ",
"APMRouteCreateOptions",
">; } & { \"GET /api/apm/backends/top_backends\": ",
"ServerRoute",
"<\"GET /api/apm/backends/top_backends\", ",
"IntersectionC",
"<[",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ numBuckets: ",
"Type",
"<number, unknown, unknown>; }>]>; }>, ",
"PartialC",
"<{ query: ",
"IntersectionC",
"<[",
"PartialC",
"<{ environment: ",
"StringC",
"; }>, ",
"PartialC",
"<{ offset: ",
"StringC",
"; }>]>; }>]>, ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMRouteHandlerResources",
"text": "APMRouteHandlerResources"
},
", { backends: { currentStats: { latency: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; throughput: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; errorRate: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; } & { impact: number; }; previousStats: ({ latency: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; throughput: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; errorRate: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; } & { impact: number; }) | null; location: ",
"Node",
"; }[]; }, ",
"APMRouteCreateOptions",
">; } & { \"GET /api/apm/backends/{backendName}/upstream_services\": ",
"ServerRoute",
"<\"GET /api/apm/backends/{backendName}/upstream_services\", ",
"IntersectionC",
"<[",
"TypeC",
"<{ path: ",
"TypeC",
"<{ backendName: ",
"StringC",
"; }>; query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ numBuckets: ",
"Type",
"<number, unknown, unknown>; }>]>; }>, ",
"PartialC",
"<{ query: ",
"IntersectionC",
"<[",
"PartialC",
"<{ environment: ",
"StringC",
"; }>, ",
"PartialC",
"<{ offset: ",
"StringC",
"; }>]>; }>]>, ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMRouteHandlerResources",
"text": "APMRouteHandlerResources"
},
", { services: { currentStats: { latency: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; throughput: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; errorRate: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; } & { impact: number; }; previousStats: ({ latency: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; throughput: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; errorRate: { value: number | null; timeseries: ",
"Coordinate",
"[]; }; } & { impact: number; }) | null; location: ",
"Node",
"; }[]; }, ",
"APMRouteCreateOptions",
">; } & { \"GET /api/apm/backends/{backendName}/metadata\": ",
"ServerRoute",
"<\"GET /api/apm/backends/{backendName}/metadata\", ",
Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import apmObj from './apm.json';




Contact APM UI for questions regarding this plugin.

**Code health stats**

Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm_oss.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import apmOssObj from './apm_oss.json';




Contact APM UI for questions regarding this plugin.

**Code health stats**

Expand Down
Loading

0 comments on commit 70b8d81

Please sign in to comment.