Skip to content

Commit

Permalink
Track API stats as part of ci (#95733) (#97306)
Browse files Browse the repository at this point in the history 
* 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 <[email protected]>
# Conflicts:
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/reporting.json
  • Loading branch information
@stacey-gammon
stacey-gammon authored Apr 15, 2021
1 parent 57bce49 commit 0a2799d
Show file tree
Hide file tree
Showing 117 changed files with 13,519 additions and 9,627 deletions.
229 changes: 171 additions & 58 deletions api_docs/actions.json
View file

Large diffs are not rendered by default.

119 changes: 58 additions & 61 deletions api_docs/alerting.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,7 @@
},
"signature": [
"(consumer: string, alertType: string, handler: ",
{
"pluginId": "alerting",
"scope": "public",
"docId": "kibAlertingPluginApi",
"section": "def-public.AlertNavigationHandler",
"text": "AlertNavigationHandler"
},
"AlertNavigationHandler",
") => void"
]
},
Expand All @@ -48,13 +42,7 @@
},
"signature": [
"(consumer: string, handler: ",
{
"pluginId": "alerting",
"scope": "public",
"docId": "kibAlertingPluginApi",
"section": "def-public.AlertNavigationHandler",
"text": "AlertNavigationHandler"
},
"AlertNavigationHandler",
") => void"
]
}
Expand Down Expand Up @@ -115,6 +103,40 @@
"server": {
"classes": [],
"functions": [
{
"id": "def-server.getEsErrorMessage",
"type": "Function",
"children": [
{
"id": "def-server.getEsErrorMessage.$1",
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"ElasticsearchError"
],
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts",
"lineNumber": 37
}
}
],
"signature": [
"(error: ",
"ElasticsearchError",
") => string"
],
"description": [],
"label": "getEsErrorMessage",
"source": {
"path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts",
"lineNumber": 37
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.parseDuration",
"type": "Function",
Expand All @@ -125,6 +147,7 @@
"description": [],
"children": [
{
"id": "def-server.parseDuration.$1",
"type": "string",
"label": "duration",
"isRequired": true,
Expand Down Expand Up @@ -429,13 +452,7 @@
},
"signature": [
"() => Set<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RegistryAlertType",
"text": "RegistryAlertType"
},
"RegistryAlertType",
">"
]
},
Expand Down Expand Up @@ -552,13 +569,7 @@
},
"signature": [
"(id: string) => Pick<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertInstance",
"text": "AlertInstance"
},
"AlertInstance",
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
]
}
Expand Down Expand Up @@ -620,13 +631,7 @@
},
"signature": [
"{ params?: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertTypeParamsValidator",
"text": "AlertTypeParamsValidator"
},
"AlertTypeParamsValidator",
"<Params> | undefined; } | undefined"
]
},
Expand Down Expand Up @@ -697,13 +702,7 @@
"lineNumber": 128
},
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.ExecutorType",
"text": "ExecutorType"
},
"ExecutorType",
"<Params, State, InstanceState, InstanceContext, ",
{
"pluginId": "alerting",
Expand Down Expand Up @@ -854,7 +853,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
]
}
],
Expand Down Expand Up @@ -889,6 +888,7 @@
"description": [],
"children": [
{
"id": "def-server.PluginSetupContract.registerType.$1",
"type": "Object",
"label": "alertType",
"isRequired": true,
Expand Down Expand Up @@ -942,13 +942,7 @@
},
"signature": [
"() => Set<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RegistryAlertType",
"text": "RegistryAlertType"
},
"RegistryAlertType",
">"
]
},
Expand Down Expand Up @@ -978,6 +972,7 @@
"description": [],
"children": [
{
"id": "def-server.PluginStartContract.getAlertsClientWithRequest.$1",
"type": "Object",
"label": "request",
"isRequired": true,
Expand Down Expand Up @@ -1116,7 +1111,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: ",
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: ",
"CreateOptions",
"<Params>) => Promise<Pick<",
{
Expand All @@ -1126,7 +1121,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params>({ options: { fields, ...options }, }?: { options?: ",
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params>({ options: { fields, ...options }, }?: { options?: ",
"FindOptions",
" | undefined; }) => Promise<",
{
Expand Down Expand Up @@ -1180,7 +1175,7 @@
"lineNumber": 178
},
"signature": [
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"
],
"initialIsOpen": false
},
Expand Down Expand Up @@ -1239,6 +1234,7 @@
"description": [],
"children": [
{
"id": "def-common.getBuiltinActionGroups.$1",
"type": "Object",
"label": "customRecoveryGroup",
"isRequired": false,
Expand Down Expand Up @@ -1277,6 +1273,7 @@
"description": [],
"children": [
{
"id": "def-common.getDurationNumberInItsUnit.$1",
"type": "string",
"label": "duration",
"isRequired": true,
Expand Down Expand Up @@ -1308,6 +1305,7 @@
"description": [],
"children": [
{
"id": "def-common.getDurationUnitValue.$1",
"type": "string",
"label": "duration",
"isRequired": true,
Expand Down Expand Up @@ -1339,6 +1337,7 @@
"description": [],
"children": [
{
"id": "def-common.isActionGroupDisabledForActionTypeId.$1",
"type": "string",
"label": "actionGroup",
"isRequired": true,
Expand All @@ -1352,6 +1351,7 @@
}
},
{
"id": "def-common.isActionGroupDisabledForActionTypeId.$2",
"type": "string",
"label": "actionTypeId",
"isRequired": true,
Expand Down Expand Up @@ -1383,6 +1383,7 @@
"description": [],
"children": [
{
"id": "def-common.parseDuration.$1",
"type": "string",
"label": "duration",
"isRequired": true,
Expand Down Expand Up @@ -1414,6 +1415,7 @@
"description": [],
"children": [
{
"id": "def-common.validateDurationSchema.$1",
"type": "string",
"label": "duration",
"isRequired": true,
Expand Down Expand Up @@ -1445,6 +1447,7 @@
"description": [],
"children": [
{
"id": "def-common.validateNotifyWhenType.$1",
"type": "string",
"label": "notifyWhen",
"isRequired": true,
Expand Down Expand Up @@ -1951,13 +1954,7 @@
"lineNumber": 47
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
"SavedObjectAttributes"
]
}
],
Expand Down Expand Up @@ -3120,7 +3117,7 @@
"lineNumber": 78
},
"signature": [
"{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }"
"{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }"
],
"initialIsOpen": false
},
Expand Down
Loading

0 comments on commit 0a2799d

Please sign in to comment.