Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] Add packages to our API documentation (#113564) #114513

Merged
merged 1 commit into from
Oct 11, 2021
Merged

[7.x] Add packages to our API documentation (#113564) #114513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions api_docs/actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: kibActionsPluginApi
slug: /kibana-dev-docs/actionsPluginApi
title: actions
slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the actions plugin
date: 2020-11-16
Expand Down
4 changes: 2 additions & 2 deletions api_docs/advanced_settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: kibAdvancedSettingsPluginApi
slug: /kibana-dev-docs/advancedSettingsPluginApi
title: advancedSettings
slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the advancedSettings plugin
date: 2020-11-16
Expand Down
61 changes: 55 additions & 6 deletions api_docs/alerting.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
"JsonObject"
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
}
],
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
"deprecated": false,
Expand Down Expand Up @@ -510,9 +516,21 @@
", filterOpts: ",
"AlertingAuthorizationFilterOpts",
") => Promise<{ filter?: ",
"KueryNode",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | ",
"JsonObject",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
Expand Down Expand Up @@ -590,9 +608,21 @@
"text": "WriteOperations"
},
") => Promise<{ filter?: ",
"KueryNode",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | ",
"JsonObject",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
Expand Down Expand Up @@ -1537,6 +1567,19 @@
"description": [],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertType.ruleTaskTimeout",
"type": "string",
"tags": [],
"label": "ruleTaskTimeout",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
Expand Down Expand Up @@ -3388,7 +3431,13 @@
"label": "state",
"description": [],
"signature": [
"JsonObject"
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
}
],
"path": "x-pack/plugins/alerting/common/alert_navigation.ts",
"deprecated": false
Expand Down
6 changes: 3 additions & 3 deletions api_docs/alerting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: kibAlertingPluginApi
slug: /kibana-dev-docs/alertingPluginApi
title: alerting
slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the alerting plugin
date: 2020-11-16
Expand All @@ -18,7 +18,7 @@ Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 248 | 0 | 240 | 16 |
| 249 | 0 | 241 | 16 |

## Client

Expand Down
Loading