* Fix "to to" spelling error * Build API docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Michael Paul <michael@michaelpaul.com.br> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Stratoula Kalafateli
GitHub
parent
34a7dae336
commit
648c40646b
26 changed files with 26 additions and 26 deletions
|
|
@ -4242,7 +4242,7 @@
|
|||
"type": "string",
|
||||
"label": "actionPath",
|
||||
"description": [
|
||||
"The path (without the basePath) that the user should be redirect to to address this warning."
|
||||
"The path (without the basePath) that the user should be redirect to address this warning."
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/server/saved_objects/import/types.ts",
|
||||
|
|
|
|||
|
|
@ -1638,7 +1638,7 @@
|
|||
"deprecated"
|
||||
],
|
||||
"description": [
|
||||
"\nA handler that will be executed before leaving the application, either when\ngoing to another application or when closing the browser tab or manually changing\nthe url.\nShould return `confirm` to to prompt a message to the user before leaving the page, or `default`\nto keep the default behavior (doing nothing).\n\nSee {@link AppMountParameters} for detailed usage examples.\n"
|
||||
"\nA handler that will be executed before leaving the application, either when\ngoing to another application or when closing the browser tab or manually changing\nthe url.\nShould return `confirm` to prompt a message to the user before leaving the page, or `default`\nto keep the default behavior (doing nothing).\n\nSee {@link AppMountParameters} for detailed usage examples.\n"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
|
|||
|
|
@ -10080,7 +10080,7 @@
|
|||
"type": "string",
|
||||
"label": "actionPath",
|
||||
"description": [
|
||||
"The path (without the basePath) that the user should be redirect to to address this warning."
|
||||
"The path (without the basePath) that the user should be redirect to address this warning."
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/server/saved_objects/import/types.ts",
|
||||
|
|
|
|||
|
|
@ -751,7 +751,7 @@
|
|||
"type": "string",
|
||||
"label": "tagFeatureId",
|
||||
"description": [
|
||||
"\nThe id of the tagging feature as registered to to `features` plugin"
|
||||
"\nThe id of the tagging feature as registered to `features` plugin"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/saved_objects_tagging/common/constants.ts",
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ cd ../kibana
|
|||
----
|
||||
|
||||
. Change the elasticsearch credentials in your `kibana.yml` configuration file to match those needed by elasticsearch and the APM server (see the apm-integration-testing repo's https://github.com/elastic/apm-integration-testing#logging-in[README] for users provided to test different scenarios).
|
||||
. Make sure that the APM agent is active and points to the local APM server by adding the following configuration settings to to a config file under `config/apm.dev.js`:
|
||||
. Make sure that the APM agent is active and points to the local APM server by adding the following configuration settings to a config file under `config/apm.dev.js`:
|
||||
+
|
||||
Example `config/apm.dev.js` file:
|
||||
+
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
> [AppMountParameters.onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) has been deprecated in favor of [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md)
|
||||
>
|
||||
|
||||
A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return `confirm` to to prompt a message to the user before leaving the page, or `default` to keep the default behavior (doing nothing).
|
||||
A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return `confirm` to prompt a message to the user before leaving the page, or `default` to keep the default behavior (doing nothing).
|
||||
|
||||
See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples.
|
||||
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
|
|||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md) | Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)<!-- -->See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) |
|
||||
| [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) | A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return <code>confirm</code> to to prompt a message to the user before leaving the page, or <code>default</code> to keep the default behavior (doing nothing).<!-- -->See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. |
|
||||
| [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) | A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return <code>confirm</code> to prompt a message to the user before leaving the page, or <code>default</code> to keep the default behavior (doing nothing).<!-- -->See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. |
|
||||
| [AppMount](./kibana-plugin-core-public.appmount.md) | A mount function called when the user navigates to this app's route. |
|
||||
| [AppSearchDeepLink](./kibana-plugin-core-public.appsearchdeeplink.md) | Input type for registering secondary in-app locations for an application.<!-- -->Deep links must include at least one of <code>path</code> or <code>searchDeepLinks</code>. A deep link that does not have a <code>path</code> represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
|
||||
| [AppUnmount](./kibana-plugin-core-public.appunmount.md) | A function called when an application should be unmounted from the page. This function should be synchronous. |
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## SavedObjectsImportActionRequiredWarning.actionPath property
|
||||
|
||||
The path (without the basePath) that the user should be redirect to to address this warning.
|
||||
The path (without the basePath) that the user should be redirect to address this warning.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ export interface SavedObjectsImportActionRequiredWarning
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [actionPath](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md) | <code>string</code> | The path (without the basePath) that the user should be redirect to to address this warning. |
|
||||
| [actionPath](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md) | <code>string</code> | The path (without the basePath) that the user should be redirect to address this warning. |
|
||||
| [buttonLabel](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md) | <code>string</code> | An optional label to use for the link button. If unspecified, a default label will be used. |
|
||||
| [message](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md) | <code>string</code> | The translated message to display to the user. |
|
||||
| [type](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md) | <code>'action_required'</code> | |
|
||||
|
|
|
|||
|
|
@ -300,7 +300,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
|
|||
| [SavedObjectAttributeSingle](./kibana-plugin-core-server.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) |
|
||||
| [SavedObjectMigrationFn](./kibana-plugin-core-server.savedobjectmigrationfn.md) | A migration function for a [saved object type](./kibana-plugin-core-server.savedobjectstype.md) used to migrate it to a given version |
|
||||
| [SavedObjectSanitizedDoc](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) | Describes Saved Object documents that have passed through the migration framework and are guaranteed to have a <code>references</code> root property. |
|
||||
| [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.<!-- -->\#\# SavedObjectsClient errors<!-- -->Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:<!-- -->1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md)<!-- -->Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the <code>isXYZError()</code> helpers exposed at <code>SavedObjectsErrorHelpers</code> should be used to understand and manage error responses from the <code>SavedObjectsClient</code>.<!-- -->Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for <code>error.body.error.type</code> or doing substring checks on <code>error.body.error.reason</code>, just use the helpers to understand the meaning of the error:<!-- -->\`\`\`<!-- -->js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }<!-- -->if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }<!-- -->// always rethrow the error unless you handle it throw error; \`\`\`<!-- -->\#\#\# 404s from missing index<!-- -->From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.<!-- -->At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.<!-- -->From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.<!-- -->See [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) |
|
||||
| [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.<!-- -->\#\# SavedObjectsClient errors<!-- -->Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to application code. Ideally, all errors will be either:<!-- -->1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md)<!-- -->Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the <code>isXYZError()</code> helpers exposed at <code>SavedObjectsErrorHelpers</code> should be used to understand and manage error responses from the <code>SavedObjectsClient</code>.<!-- -->Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for <code>error.body.error.type</code> or doing substring checks on <code>error.body.error.reason</code>, just use the helpers to understand the meaning of the error:<!-- -->\`\`\`<!-- -->js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }<!-- -->if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }<!-- -->// always rethrow the error unless you handle it throw error; \`\`\`<!-- -->\#\#\# 404s from missing index<!-- -->From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.<!-- -->At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.<!-- -->From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.<!-- -->See [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) |
|
||||
| [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md) | Describes the factory used to create instances of the Saved Objects Client. |
|
||||
| [SavedObjectsClientFactoryProvider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) | Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md)<!-- -->. |
|
||||
| [SavedObjectsClientWrapperFactory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) | Describes the factory used to create instances of Saved Objects Client Wrappers. |
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Saved Objects is Kibana's data persisentence mechanism allowing plugins to use E
|
|||
|
||||
\#\# SavedObjectsClient errors
|
||||
|
||||
Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:
|
||||
Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to application code. Ideally, all errors will be either:
|
||||
|
||||
1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## SavedObjectsImportActionRequiredWarning.actionPath property
|
||||
|
||||
The path (without the basePath) that the user should be redirect to to address this warning.
|
||||
The path (without the basePath) that the user should be redirect to address this warning.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ export interface SavedObjectsImportActionRequiredWarning
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [actionPath](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md) | <code>string</code> | The path (without the basePath) that the user should be redirect to to address this warning. |
|
||||
| [actionPath](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md) | <code>string</code> | The path (without the basePath) that the user should be redirect to address this warning. |
|
||||
| [buttonLabel](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md) | <code>string</code> | An optional label to use for the link button. If unspecified, a default label will be used. |
|
||||
| [message](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md) | <code>string</code> | The translated message to display to the user. |
|
||||
| [type](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md) | <code>'action_required'</code> | |
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ and guides you through the process of resolving issues, including reindexing.
|
|||
|
||||
Before you upgrade, make sure that you are using the latest released minor
|
||||
version of {es} to see the most up-to-date deprecation issues.
|
||||
For example, if you want to upgrade to to 7.0, make sure that you are using 6.8.
|
||||
For example, if you want to upgrade to 7.0, make sure that you are using 6.8.
|
||||
|
||||
[float]
|
||||
=== Required permissions
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ reports, you might need to change the following settings.
|
|||
Valid values are `year`, `month`, `week`, `day`, and `hour`. Defaults to `week`.
|
||||
|
||||
| `xpack.reporting.queue.pollEnabled` {ess-icon}
|
||||
| Set to `true` (default) to enable the {kib} instance to to poll the index for
|
||||
| Set to `true` (default) to enable the {kib} instance to poll the index for
|
||||
pending jobs and claim them for execution. Setting this to `false` allows the
|
||||
{kib} instance to only add new jobs to the reporting queue, list jobs, and
|
||||
provide the downloads to completed report through the UI.
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ of any statistical correlation with the sample.
|
|||
required to assert a relationship.
|
||||
|
||||
[discrete]
|
||||
=== What can I do to to improve performance?
|
||||
=== What can I do to improve performance?
|
||||
|
||||
With the default setting of `use_significance` set to `true`, the Graph API
|
||||
performs a background frequency check of the terms it discovers as part of
|
||||
|
|
|
|||
|
|
@ -519,7 +519,7 @@ export interface AppMountParameters<HistoryLocationState = unknown> {
|
|||
* A handler that will be executed before leaving the application, either when
|
||||
* going to another application or when closing the browser tab or manually changing
|
||||
* the url.
|
||||
* Should return `confirm` to to prompt a message to the user before leaving the page, or `default`
|
||||
* Should return `confirm` to prompt a message to the user before leaving the page, or `default`
|
||||
* to keep the default behavior (doing nothing).
|
||||
*
|
||||
* See {@link AppMountParameters} for detailed usage examples.
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@ export interface SavedObjectsImportActionRequiredWarning {
|
|||
type: 'action_required';
|
||||
/** The translated message to display to the user. */
|
||||
message: string;
|
||||
/** The path (without the basePath) that the user should be redirect to to address this warning. */
|
||||
/** The path (without the basePath) that the user should be redirect to address this warning. */
|
||||
actionPath: string;
|
||||
/** An optional label to use for the link button. If unspecified, a default label will be used. */
|
||||
buttonLabel?: string;
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ run(async ({ log }) => {
|
|||
// include files from node_modules in the result, but it still
|
||||
// loads all of the files from node_modules before filtering
|
||||
// so it's still super slow. This prevents loading the files
|
||||
// and still relies on gitignore to to final ignores
|
||||
// and still relies on gitignore to final ignores
|
||||
'**/node_modules',
|
||||
],
|
||||
});
|
||||
|
|
|
|||
|
|
@ -638,7 +638,7 @@ export const createDotNetAgentInstructions = (apmServerUrl = '', secretToken = '
|
|||
'Add the the agent package(s) from [NuGet]({allNuGetPackagesLink}) to your .NET application. There are multiple \
|
||||
NuGet packages available for different use cases. \n\nFor an ASP.NET Core application with Entity Framework \
|
||||
Core download the [Elastic.Apm.NetCoreAll]({netCoreAllApmPackageLink}) package. This package will automatically add every \
|
||||
agent component to your application. \n\n In case you would like to to minimize the dependencies, you can use the \
|
||||
agent component to your application. \n\n In case you would like to minimize the dependencies, you can use the \
|
||||
[Elastic.Apm.AspNetCore]({aspNetCorePackageLink}) package for just \
|
||||
ASP.NET Core monitoring or the [Elastic.Apm.EfCore]({efCorePackageLink}) package for just Entity Framework Core monitoring. \n\n \
|
||||
In case you only want to use the public Agent API for manual instrumentation use the [Elastic.Apm]({elasticApmPackageLink}) package.',
|
||||
|
|
|
|||
|
|
@ -303,7 +303,7 @@ export interface ParseSearchQueryOptions {
|
|||
*
|
||||
* Defaults to true.
|
||||
*
|
||||
* @remarks this must be set to to true if the filter is configured to use tag names instead of id in the query.
|
||||
* @remarks this must be set to true if the filter is configured to use tag names instead of id in the query.
|
||||
* see {@link GetSearchBarFilterOptions.useName} for more details.
|
||||
*/
|
||||
useName?: boolean;
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ export default new Datasource('static', {
|
|||
types: ['number', 'string'],
|
||||
help: i18n.translate('timelion.help.functions.static.args.valueHelpText', {
|
||||
defaultMessage:
|
||||
'The single value to to display, you can also pass several values and I will interpolate them evenly across your time range.',
|
||||
'The single value to display, you can also pass several values and I will interpolate them evenly across your time range.',
|
||||
}),
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ The more cores the better, as the build makes effective use of each. For Linux,
|
|||
|
||||
## Initializing each VM / environment
|
||||
|
||||
In a VM, you'll want to use the init scripts to to initialize each environment.
|
||||
In a VM, you'll want to use the init scripts to initialize each environment.
|
||||
On Mac OS you'll need to install XCode and accept the license agreement.
|
||||
|
||||
Create the build folder:
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* The id of the tagging feature as registered to to `features` plugin
|
||||
* The id of the tagging feature as registered to `features` plugin
|
||||
*/
|
||||
export const tagFeatureId = 'savedObjectsTagging';
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ describe('When invoking Trusted Apps Schema', () => {
|
|||
expect(body.validate(bodyMsg)).toStrictEqual(bodyMsg);
|
||||
});
|
||||
|
||||
it('should validate `os` to to only accept known values', () => {
|
||||
it('should validate `os` to only accept known values', () => {
|
||||
const bodyMsg = createNewTrustedApp({ os: undefined });
|
||||
expect(() => body.validate(bodyMsg)).toThrow();
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ type EventHandlerCallback = MouseEventHandler<HTMLButtonElement | HTMLAnchorElem
|
|||
|
||||
/**
|
||||
* Provides an event handler that can be used with (for example) `onClick` props to prevent the
|
||||
* event's default behaviour and instead navigate to to a route via the Router
|
||||
* event's default behaviour and instead navigate to a route via the Router
|
||||
*
|
||||
* @param routeTo
|
||||
* @param onClick
|
||||
|
|
|
|||
Loading…
Reference in a new issue