Skip to content

[Mappings editor] Clarify the loading JSON will overwrite existing mappings #54532

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

Merged
cjcenizal merged 4 commits into from
Jan 14, 2020
Merged

[Mappings editor] Clarify the loading JSON will overwrite existing mappings #54532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54c0e35
Clarify the loading JSON will overwrite existing mappings and that yo…
cjcenizal Jan 11, 2020
2309b79
Refine copy.
cjcenizal Jan 13, 2020
54ab295
Refine copy of mapped fields tab.
cjcenizal Jan 13, 2020
f85cd21
Fix i18n errors.
cjcenizal Jan 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...blic/app/components/mappings_editor/components/document_fields/document_fields_header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const DocumentFieldsHeader = () => {
<EuiText size="s" color="subdued">
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.documentFieldsDescription"
defaultMessage="Define the fields you expect your indexed documents to have. {docsLink}"
defaultMessage="Define the fields for your indexed documents. {docsLink}"
values={{
docsLink: (
<EuiLink href={documentationService.getMappingTypesLink()} target="_blank">
Expand Down
61 changes: 34 additions & 27 deletions ...public/app/components/mappings_editor/components/load_mappings/load_mappings_provider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
import { JsonEditor, OnJsonEditorUpdateHandler } from '../../shared_imports';
import { validateMappings, MappingsValidationError } from '../../lib';

const MAX_ERRORS_TO_DISPLAY = 10;
const MAX_ERRORS_TO_DISPLAY = 1;

type OpenJsonModalFunc = () => void;

Expand All @@ -40,17 +40,17 @@ interface State {
type ModalView = 'json' | 'validationResult';

const getTexts = (view: ModalView, totalErrors = 0) => ({
modalTitle: i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModal.title', {
defaultMessage: 'Load mappings from JSON',
modalTitle: i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModalTitle', {
defaultMessage: 'Load JSON',
}),
buttons: {
confirm:
view === 'json'
? i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModal.loadButtonLabel', {
defaultMessage: 'Load',
defaultMessage: 'Load and overwrite',
})
: i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModal.acceptWarningLabel', {
defaultMessage: 'OK',
defaultMessage: 'Continue loading',
}),
cancel:
view === 'json'
Expand All @@ -65,24 +65,23 @@ const getTexts = (view: ModalView, totalErrors = 0) => ({
label: i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModal.jsonEditorLabel', {
defaultMessage: 'Mappings object',
}),
helpText: i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModal.jsonEditorHelpText', {
defaultMessage:
'Provide the complete mappings object with both the configuration and the properties.',
}),
},
validationErrors: {
title: i18n.translate('xpack.idxMgmt.mappingsEditor.loadJsonModal.validationErrorTitle', {
defaultMessage:
'{totalErrors} {totalErrors, plural, one {error} other {errors}} detected in the mappings object',
values: {
totalErrors,
},
}),
title: (
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationErrorTitle"
defaultMessage="{totalErrors} {totalErrors, plural, one {invalid option} other {invalid options}} detected in {mappings} object"
values={{
totalErrors,
// NOTE: This doesn't need internationalization because it's part of the ES API.
mappings: <code>mappings</code>,
}}
/>
),
description: i18n.translate(
'xpack.idxMgmt.mappingsEditor.loadJsonModal.validationErrorDescription',
{
defaultMessage:
'The mappings provided contains some errors. You can safely ignore them: the configuration, field or parameter containing an error will be discarded before loading the JSON object in the editor.',
defaultMessage: 'If you continue loading the object, only valid options will be accepted.',
}
),
},
Expand All @@ -93,7 +92,7 @@ const getErrorMessage = (error: MappingsValidationError) => {
case 'ERR_CONFIG': {
return (
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationError.configuration"
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationError.configurationMessage"
defaultMessage="The {configName} configuration is invalid."
values={{
configName: <code>{error.configName}</code>,
Expand All @@ -104,7 +103,7 @@ const getErrorMessage = (error: MappingsValidationError) => {
case 'ERR_FIELD': {
return (
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationError.field"
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationError.fieldMessage"
defaultMessage="The {fieldPath} field is invalid."
values={{
fieldPath: <code>{error.fieldPath}</code>,
Expand All @@ -115,7 +114,7 @@ const getErrorMessage = (error: MappingsValidationError) => {
case 'ERR_PARAMETER': {
return (
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationError.parameter"
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.validationError.parameterMessage"
defaultMessage="The {paramName} parameter on field {fieldPath} is invalid."
values={{
paramName: <code>{error.paramName}</code>,
Expand Down Expand Up @@ -195,11 +194,8 @@ export const LoadMappingsProvider = ({ onJson, children }: Props) => {
iconType={showingAllErrors ? 'arrowUp' : 'arrowDown'}
>
{showingAllErrors
? i18n.translate('xpack.idxMgmt.mappingsEditor.showFirstErrorsButtonLabel', {
defaultMessage: 'Show first {numErrors} errors',
values: {
numErrors: MAX_ERRORS_TO_DISPLAY,
},
? i18n.translate('xpack.idxMgmt.mappingsEditor.hideErrorsButtonLabel', {
defaultMessage: 'Hide errors',
})
: i18n.translate('xpack.idxMgmt.mappingsEditor.showAllErrorsButtonLabel', {
defaultMessage: 'Show {numErrors} more errors',
Expand Down Expand Up @@ -228,9 +224,20 @@ export const LoadMappingsProvider = ({ onJson, children }: Props) => {
{view === 'json' ? (
// The CSS override for the EuiCodeEditor requires a parent .application css class
<div className="application">
<EuiText color="subdued">
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.loadJsonModal.jsonEditorHelpText"
defaultMessage="Provide a mappings object, for example, the object assigned to an index {mappings} property. This will overwrite existing mappings, dynamic templates, and options"
values={{
mappings: <code>mappings</code>,
}}
/>
</EuiText>

<EuiSpacer size="m" />

<JsonEditor
label={i18nTexts.editor.label}
helpText={i18nTexts.editor.helpText}
onUpdate={onJsonUpdate}
defaultValue={state.json?.unparsed}
euiCodeEditorProps={{
Expand Down