diff --git a/docs/development/core/server/kibana-plugin-server.authtoolkit.md b/docs/development/core/server/kibana-plugin-server.authtoolkit.md index a6a30dae894ad..4e523a7ce3cf5 100644 --- a/docs/development/core/server/kibana-plugin-server.authtoolkit.md +++ b/docs/development/core/server/kibana-plugin-server.authtoolkit.md @@ -18,5 +18,5 @@ export interface AuthToolkit | --- | --- | --- | | [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | (data?: AuthResultParams) => AuthResult | Authentication is successful with given credentials, allow request to pass through | | [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | () => AuthResult | User has no credentials. Allows user to access a resource when authRequired: 'optional' Rejects a request when authRequired: true | -| [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | (headers: {
location: string;
} & ResponseHeaders) => AuthResult | Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' | +| [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | (headers: {
location: string;
} & ResponseHeaders) => AuthResult | Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' | diff --git a/docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md b/docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md index 64d1d04a4abc0..15d5498d90119 100644 --- a/docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md +++ b/docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md @@ -4,7 +4,7 @@ ## AuthToolkit.redirected property -Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' +Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' Signature: diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.dynamic.md b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.dynamic.md index 27ac92a5a40b0..b6a3fa7a39811 100644 --- a/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.dynamic.md +++ b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.dynamic.md @@ -4,10 +4,10 @@ ## SavedObjectsTypeMappingDefinition.dynamic property -The dynamic property of the mapping. either `true`, `false` or 'strict'. Defaults to `false` +The dynamic property of the mapping. either `false` or 'strict'. Defaults to `false` Signature: ```typescript -dynamic?: boolean | 'strict'; +dynamic?: false | 'strict'; ``` diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md index 4f5325066e356..2f60c04f5f917 100644 --- a/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md +++ b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md @@ -41,6 +41,6 @@ const typeDefinition: SavedObjectsTypeMappingDefinition = { | Property | Type | Description | | --- | --- | --- | -| [dynamic](./kibana-plugin-server.savedobjectstypemappingdefinition.dynamic.md) | boolean | 'strict' | The dynamic property of the mapping. either true, false or 'strict'. Defaults to false | +| [dynamic](./kibana-plugin-server.savedobjectstypemappingdefinition.dynamic.md) | false | 'strict' | The dynamic property of the mapping. either false or 'strict'. Defaults to false | | [properties](./kibana-plugin-server.savedobjectstypemappingdefinition.properties.md) | SavedObjectsMappingProperties | The underlying properties of the type mapping | diff --git a/src/core/server/saved_objects/mappings/types.ts b/src/core/server/saved_objects/mappings/types.ts index 5caa754f11fc8..47fc29f8cf7d2 100644 --- a/src/core/server/saved_objects/mappings/types.ts +++ b/src/core/server/saved_objects/mappings/types.ts @@ -45,8 +45,8 @@ * @public */ export interface SavedObjectsTypeMappingDefinition { - /** The dynamic property of the mapping. either `true`, `false` or 'strict'. Defaults to `false` */ - dynamic?: boolean | 'strict'; + /** The dynamic property of the mapping. either `false` or 'strict'. Defaults to `false` */ + dynamic?: false | 'strict'; /** The underlying properties of the type mapping */ properties: SavedObjectsMappingProperties; } diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 6622f30001539..5ede98a1e6e6d 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -2173,7 +2173,7 @@ export interface SavedObjectsTypeManagementDefinition { // @public export interface SavedObjectsTypeMappingDefinition { - dynamic?: boolean | 'strict'; + dynamic?: false | 'strict'; properties: SavedObjectsMappingProperties; } diff --git a/src/core/server/ui_settings/saved_objects/ui_settings.ts b/src/core/server/ui_settings/saved_objects/ui_settings.ts index 68cac3eaee585..031315bec0dab 100644 --- a/src/core/server/ui_settings/saved_objects/ui_settings.ts +++ b/src/core/server/ui_settings/saved_objects/ui_settings.ts @@ -24,7 +24,10 @@ export const uiSettingsType: SavedObjectsType = { hidden: false, namespaceAgnostic: false, mappings: { - dynamic: true, + // we don't want to allow `true` in the public `SavedObjectsTypeMappingDefinition` type, however + // this is needed for the config that is kinda a special type. To avoid adding additional internal types + // just for this, we hardcast to any here. + dynamic: true as any, properties: { buildNum: { type: 'keyword',