From 3fb6174e7146efce5fb871ead60611ee481c73ac Mon Sep 17 00:00:00 2001 From: restrry Date: Wed, 3 Mar 2021 14:18:07 +0100 Subject: [PATCH] update docs --- ...gin-core-server.explanation.description.md | 11 ---------- ...-plugin-core-server.explanation.details.md | 11 ---------- .../kibana-plugin-core-server.explanation.md | 21 ------------------- ...na-plugin-core-server.explanation.value.md | 11 ---------- .../core/server/kibana-plugin-core-server.md | 1 - ...savedobjectsrepository.incrementcounter.md | 2 +- src/core/server/server.api.md | 11 +--------- 7 files changed, 2 insertions(+), 66 deletions(-) delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.description.md delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.details.md delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.md delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.value.md diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.description.md b/docs/development/core/server/kibana-plugin-core-server.explanation.description.md deleted file mode 100644 index 37fc90f5ac5d8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.description.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) > [description](./kibana-plugin-core-server.explanation.description.md) - -## Explanation.description property - -Signature: - -```typescript -description: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.details.md b/docs/development/core/server/kibana-plugin-core-server.explanation.details.md deleted file mode 100644 index afba9175d86cf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.details.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) > [details](./kibana-plugin-core-server.explanation.details.md) - -## Explanation.details property - -Signature: - -```typescript -details: Explanation[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.md b/docs/development/core/server/kibana-plugin-core-server.explanation.md deleted file mode 100644 index eb18910c4795b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) - -## Explanation interface - - -Signature: - -```typescript -export interface Explanation -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description](./kibana-plugin-core-server.explanation.description.md) | string | | -| [details](./kibana-plugin-core-server.explanation.details.md) | Explanation[] | | -| [value](./kibana-plugin-core-server.explanation.value.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.value.md b/docs/development/core/server/kibana-plugin-core-server.explanation.value.md deleted file mode 100644 index b10f60176b0c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) > [value](./kibana-plugin-core-server.explanation.value.md) - -## Explanation.value property - -Signature: - -```typescript -value: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md index d14e41cfb56ec..8dd4667002ead 100644 --- a/docs/development/core/server/kibana-plugin-core-server.md +++ b/docs/development/core/server/kibana-plugin-core-server.md @@ -75,7 +75,6 @@ The plugin integrates with the core system via lifecycle events: `setup` | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | | | [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) | | | [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) | HTTP response parameters | -| [Explanation](./kibana-plugin-core-server.explanation.md) | | | [FakeRequest](./kibana-plugin-core-server.fakerequest.md) | Fake request object created manually by Kibana plugins. | | [GetResponse](./kibana-plugin-core-server.getresponse.md) | | | [HttpAuth](./kibana-plugin-core-server.httpauth.md) | | diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md index 92f5f4e2aff24..eb18e064c84e2 100644 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md +++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md @@ -31,7 +31,7 @@ The saved object after the specified fields were incremented When supplying a field name like `stats.api.counter` the field name will be used as-is to create a document like: `{attributes: {'stats.api.counter': 1}}` It will not create a nested structure like: `{attributes: {stats: {api: {counter: 1}}}}` -When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/master/src/plugins/usage\_collection/README.md\#tracking-interactions-with-incrementcounter) +When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/master/src/plugins/usage\_collection/README.mdx\#tracking-interactions-with-incrementcounter) ## Example diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 72d66bc04f08e..15adae32cca6d 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -924,16 +924,6 @@ export interface ErrorHttpResponseOptions { headers?: ResponseHeaders; } -// @public (undocumented) -export interface Explanation { - // (undocumented) - description: string; - // (undocumented) - details: Explanation[]; - // (undocumented) - value: number; -} - // @public export interface FakeRequest { headers: Headers; @@ -3198,6 +3188,7 @@ export const validBodyOutput: readonly ["data", "stream"]; // Warnings were encountered during analysis: // +// src/core/server/elasticsearch/client/types.ts:94:7 - (ae-forgotten-export) The symbol "Explanation" needs to be exported by the entry point index.d.ts // src/core/server/http/router/response.ts:297:3 - (ae-forgotten-export) The symbol "KibanaResponse" needs to be exported by the entry point index.d.ts // src/core/server/plugins/types.ts:286:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts // src/core/server/plugins/types.ts:286:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts