Skip to content

Commit 2956d43

Browse files
Merge branch 'master' into metrics_editor_state
2 parents 12d7df7 + 2c7a85d commit 2956d43

File tree

1,392 files changed

+41012
-19994
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,392 files changed

+41012
-19994
lines changed

docs/api/spaces-management/copy_saved_objects.asciidoc

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,17 @@ You can request to overwrite any objects that already exist in the target space
5151
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects will also be copied into the target
5252
spaces. The default value is `false`.
5353

54+
`createNewCopies`::
55+
(Optional, boolean) Creates new copies of saved objects, regenerates each object ID, and resets the origin. When used, potential conflict
56+
errors are avoided. The default value is `true`.
57+
+
58+
NOTE: This cannot be used with the `overwrite` option.
59+
5460
`overwrite`::
5561
(Optional, boolean) When set to `true`, all conflicts are automatically overidden. When a saved object with a matching `type` and `id`
5662
exists in the target space, that version is replaced with the version from the source space. The default value is `false`.
63+
+
64+
NOTE: This cannot be used with the `createNewCopies` option.
5765

5866
[role="child_attributes"]
5967
[[spaces-api-copy-saved-objects-response-body]]
@@ -128,8 +136,7 @@ $ curl -X POST api/spaces/_copy_saved_objects
128136
"id": "my-dashboard"
129137
}],
130138
"spaces": ["marketing"],
131-
"includeReferences": true,
132-
"createNewcopies": true
139+
"includeReferences": true
133140
}
134141
----
135142
// KIBANA
@@ -193,7 +200,8 @@ $ curl -X POST api/spaces/_copy_saved_objects
193200
"id": "my-dashboard"
194201
}],
195202
"spaces": ["marketing"],
196-
"includeReferences": true
203+
"includeReferences": true,
204+
"createNewCopies": false
197205
}
198206
----
199207
// KIBANA
@@ -254,7 +262,8 @@ $ curl -X POST api/spaces/_copy_saved_objects
254262
"id": "my-dashboard"
255263
}],
256264
"spaces": ["marketing", "sales"],
257-
"includeReferences": true
265+
"includeReferences": true,
266+
"createNewCopies": false
258267
}
259268
----
260269
// KIBANA
@@ -405,7 +414,8 @@ $ curl -X POST api/spaces/_copy_saved_objects
405414
"id": "my-dashboard"
406415
}],
407416
"spaces": ["marketing"],
408-
"includeReferences": true
417+
"includeReferences": true,
418+
"createNewCopies": false
409419
}
410420
----
411421
// KIBANA

docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ Execute the <<spaces-api-copy-saved-objects,copy saved objects to space API>>, w
4545
`includeReferences`::
4646
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects are copied into the target spaces. The `includeReferences` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation. The default value is `false`.
4747

48+
`createNewCopies`::
49+
(Optional, boolean) Creates new copies of the saved objects, regenerates each object ID, and resets the origin. When enabled during the
50+
initial copy, also enable when resolving copy errors. The default value is `true`.
51+
4852
`retries`::
4953
(Required, object) The retry operations to attempt, which can specify how to resolve different types of errors. Object keys represent the
5054
target space IDs.
@@ -148,6 +152,7 @@ $ curl -X POST api/spaces/_resolve_copy_saved_objects_errors
148152
"id": "my-dashboard"
149153
}],
150154
"includeReferences": true,
155+
"createNewCopies": false,
151156
"retries": {
152157
"sales": [
153158
{
@@ -246,6 +251,7 @@ $ curl -X POST api/spaces/_resolve_copy_saved_objects_errors
246251
"id": "my-dashboard"
247252
}],
248253
"includeReferences": true,
254+
"createNewCopies": false,
249255
"retries": {
250256
"marketing": [
251257
{

docs/api/using-api.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For all APIs, you must use a request header. The {kib} APIs support the `kbn-xsr
6161
By default, you must use `kbn-xsrf` for all API calls, except in the following scenarios:
6262

6363
* The API endpoint uses the `GET` or `HEAD` operations
64-
* The path is whitelisted using the <<settings-xsrf-whitelist, `server.xsrf.whitelist`>> setting
64+
* The path is allowed using the <<settings-xsrf-allowlist, `server.xsrf.allowlist`>> setting
6565
* XSRF protections are disabled using the <<settings-xsrf-disableProtection, `server.xsrf.disableProtection`>> setting
6666

6767
`Content-Type: application/json`::

docs/apm/api.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ users interacting with APM APIs must have <<apm-app-api-user,sufficient privileg
4040
By default, you must use `kbn-xsrf` for all API calls, except in the following scenarios:
4141

4242
* The API endpoint uses the `GET` or `HEAD` operations
43-
* The path is whitelisted using the <<settings-xsrf-whitelist, `server.xsrf.whitelist`>> setting
43+
* The path is allowed using the <<settings-xsrf-allowlist, `server.xsrf.allowlist`>> setting
4444
* XSRF protections are disabled using the <<settings-xsrf-disableProtection, `server.xsrf.disableProtection`>> setting
4545

4646
`Content-Type: application/json`::

docs/developer/getting-started/index.asciidoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,20 @@ View all available options by running `yarn start --help`
110110

111111
Read about more advanced options for <<running-kibana-advanced>>.
112112

113+
[discrete]
114+
=== Install pre-commit hook (optional)
115+
116+
In case you want to run a couple of checks like linting or check the file casing of the files to commit, we provide
117+
a way to install a pre-commit hook. To configure it you just need to run the following:
118+
119+
[source,bash]
120+
----
121+
node scripts/register_git_hook
122+
----
123+
124+
After the script completes the pre-commit hook will be created within the file `.git/hooks/pre-commit`.
125+
If you choose to not install it, don't worry, we still run a quick ci check to provide feedback earliest as we can about the same checks.
126+
113127
[discrete]
114128
=== Code away!
115129

docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export interface UiSettingsParams<T = unknown>
1919
| [category](./kibana-plugin-core-public.uisettingsparams.category.md) | <code>string[]</code> | used to group the configured setting in the UI |
2020
| [deprecation](./kibana-plugin-core-public.uisettingsparams.deprecation.md) | <code>DeprecationSettings</code> | optional deprecation information. Used to generate a deprecation warning. |
2121
| [description](./kibana-plugin-core-public.uisettingsparams.description.md) | <code>string</code> | description provided to a user in UI |
22-
| [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) | <code>{</code><br/><code> type: UiStatsMetricType;</code><br/><code> name: string;</code><br/><code> }</code> | Metric to track once this property changes |
22+
| [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) | <code>{</code><br/><code> type: UiCounterMetricType;</code><br/><code> name: string;</code><br/><code> }</code> | Metric to track once this property changes |
2323
| [name](./kibana-plugin-core-public.uisettingsparams.name.md) | <code>string</code> | title in the UI |
2424
| [optionLabels](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) | <code>Record&lt;string, string&gt;</code> | text labels for 'select' type UI element |
2525
| [options](./kibana-plugin-core-public.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |

docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Metric to track once this property changes
1515

1616
```typescript
1717
metric?: {
18-
type: UiStatsMetricType;
18+
type: UiCounterMetricType;
1919
name: string;
2020
};
2121
```

docs/development/core/server/kibana-plugin-core-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
177177
| [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) | Represents a successful import. |
178178
| [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. |
179179
| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. |
180+
| [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) | |
180181
| [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) | |
181182
| [SavedObjectsMappingProperties](./kibana-plugin-core-server.savedobjectsmappingproperties.md) | Describe the fields of a [saved object type](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md)<!-- -->. |
182183
| [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) | |
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) &gt; [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md)
4+
5+
## SavedObjectsIncrementCounterField.fieldName property
6+
7+
The field name to increment the counter by.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
fieldName: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) &gt; [incrementBy](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md)
4+
5+
## SavedObjectsIncrementCounterField.incrementBy property
6+
7+
The number to increment the field by (defaults to 1).
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
incrementBy?: number;
13+
```

0 commit comments

Comments
 (0)