Skip to content

[Mappings editor] Add descriptions for numeric types #54800

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 2 commits into from
Jan 14, 2020
Merged

[Mappings editor] Add descriptions for numeric types #54800

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40cf8ef
add description text for numeric types
alisonelizabeth Jan 14, 2020
7d45742
address review feedback
alisonelizabeth 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
100 changes: 100 additions & 0 deletions ...ndex_management/public/app/components/mappings_editor/constants/data_types_definition.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,48 +71,148 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
defaultMessage: 'Byte',
}),
value: 'byte',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.byteLongDescription"
defaultMessage="Byte fields accept a signed 8-bit integer with a minimum value of {minValue} and a maximum value of {maxValue}."
values={{
minValue: <EuiCode>-128</EuiCode>,
maxValue: <EuiCode>127</EuiCode>,
}}
/>
</p>
),
},
double: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.doubleDescription', {
defaultMessage: 'Double',
}),
value: 'double',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.doubleLongDescription"
defaultMessage="Double fields accept a double-precision 64-bit floating point number, restricted to finite values (IEEE 754)."
/>
</p>
),
},
integer: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.integerDescription', {
defaultMessage: 'Integer',
}),
value: 'integer',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.integerLongDescription"
defaultMessage="Integer fields accept a signed 32-bit integer with a minimum value of {minValue} and a maximum value of {maxValue}."
values={{
minValue: (
<EuiCode>
-2<sup className="eui-alignTop">31</sup>
</EuiCode>
),
maxValue: (
<EuiCode>
2<sup className="eui-alignTop">31</sup>-1
</EuiCode>
),
}}
/>
</p>
),
},
long: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.longDescription', {
defaultMessage: 'Long',
}),
value: 'long',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.longLongDescription"
defaultMessage="Long fields accept a signed 64-bit integer with a minimum value of {minValue} and a maximum value of {maxValue}."
values={{
minValue: (
<EuiCode>
-2<sup className="eui-alignTop">63</sup>
</EuiCode>
),
maxValue: (
<EuiCode>
2<sup className="eui-alignTop">63</sup>-1
</EuiCode>
),
}}
/>
</p>
),
},
float: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.floatDescription', {
defaultMessage: 'Float',
}),
value: 'float',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.floatLongDescription"
defaultMessage="Float fields accept a single-precision 32-bit floating point number, restricted to finite values (IEEE 754)."
/>
</p>
),
},
half_float: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.halfFloatDescription', {
defaultMessage: 'Half float',
}),
value: 'half_float',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.halfFloatLongDescription"
defaultMessage="Half-float fields accept a half-precision 16-bit floating point number, restricted to finite values (IEEE 754)."
/>
</p>
),
},
scaled_float: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.scaledFloatDescription', {
defaultMessage: 'Scaled float',
}),
value: 'scaled_float',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.scaledFloatLongDescription"
defaultMessage="Scaled-float fields accept a floating point number that is backed by a {longType} and scaled by a fixed {doubleType} scaling factor. Use this data type to store floating-point data into an integer using a scaling factor. This is helpful to save disk space, but will affect accuracy."
values={{
longType: <EuiCode>long</EuiCode>,
doubleType: <EuiCode>double</EuiCode>,
}}
/>
</p>
),
},
short: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.shortDescription', {
defaultMessage: 'Short',
}),
value: 'short',
description: () => (
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.shortLongDescription"
defaultMessage="Short fields accept a signed 16-bit integer with a minimum value of {minValue} and a maximum value of {maxValue}."
values={{
minValue: <EuiCode>-32,768</EuiCode>,
maxValue: <EuiCode>32,767</EuiCode>,
}}
/>
</p>
),
},
date: {
label: i18n.translate('xpack.idxMgmt.mappingsEditor.dataType.dateDescription', {
Expand Down