From 029869eb3550f10f2a8b3ddb6f876526a0ec61bd Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 5 Aug 2020 14:04:55 -0400 Subject: [PATCH] [DOCS] Fix metadata field refs (#60764) (#60769) --- docs/plugins/mapper-size.asciidoc | 2 +- docs/plugins/mapper.asciidoc | 2 +- .../ingest/processors/date-index-name.asciidoc | 2 +- docs/reference/mapping.asciidoc | 6 +++--- docs/reference/mapping/fields.asciidoc | 16 ++++++++-------- docs/reference/mapping/removal_of_types.asciidoc | 2 +- .../migration/migrate_7_0/mappings.asciidoc | 4 ++-- .../query-dsl/query_filter_context.asciidoc | 4 ++-- docs/reference/scripting/fields.asciidoc | 2 +- .../suggesters/completion-suggest.asciidoc | 2 +- .../authorization/field-level-security.asciidoc | 4 ++-- 11 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/plugins/mapper-size.asciidoc b/docs/plugins/mapper-size.asciidoc index aa1d4f491e0..fbfa2d062f9 100644 --- a/docs/plugins/mapper-size.asciidoc +++ b/docs/plugins/mapper-size.asciidoc @@ -1,7 +1,7 @@ [[mapper-size]] === Mapper Size Plugin -The mapper-size plugin provides the `_size` meta field which, when enabled, +The mapper-size plugin provides the `_size` metadata field which, when enabled, indexes the size in bytes of the original {ref}/mapping-source-field.html[`_source`] field. diff --git a/docs/plugins/mapper.asciidoc b/docs/plugins/mapper.asciidoc index da2920dcb02..01046d270e7 100644 --- a/docs/plugins/mapper.asciidoc +++ b/docs/plugins/mapper.asciidoc @@ -10,7 +10,7 @@ The core mapper plugins are: <>:: -The mapper-size plugin provides the `_size` meta field which, when enabled, +The mapper-size plugin provides the `_size` metadata field which, when enabled, indexes the size in bytes of the original {ref}/mapping-source-field.html[`_source`] field. diff --git a/docs/reference/ingest/processors/date-index-name.asciidoc b/docs/reference/ingest/processors/date-index-name.asciidoc index c9a1fdf5a8a..0d08244078b 100644 --- a/docs/reference/ingest/processors/date-index-name.asciidoc +++ b/docs/reference/ingest/processors/date-index-name.asciidoc @@ -4,7 +4,7 @@ The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the <>. -The processor sets the `_index` meta field with a date math index name expression based on the provided index name +The processor sets the `_index` metadata field with a date math index name expression based on the provided index name prefix, a date or timestamp field in the documents being processed and the provided date rounding. First, this processor fetches the date or timestamp from a field in the document being processed. Optionally, diff --git a/docs/reference/mapping.asciidoc b/docs/reference/mapping.asciidoc index 86664f1ed09..eef4a963902 100644 --- a/docs/reference/mapping.asciidoc +++ b/docs/reference/mapping.asciidoc @@ -15,10 +15,10 @@ are stored and indexed. For instance, use mappings to define: A mapping definition has: -<>:: +<>:: -Meta-fields are used to customize how a document's associated metadata is -treated. Examples of meta-fields include the document's +Metadata fields are used to customize how a document's associated metadata is +treated. Examples of metadata fields include the document's <>, <>, and <> fields. diff --git a/docs/reference/mapping/fields.asciidoc b/docs/reference/mapping/fields.asciidoc index ee48f7720f8..df9dbb376b5 100644 --- a/docs/reference/mapping/fields.asciidoc +++ b/docs/reference/mapping/fields.asciidoc @@ -1,12 +1,12 @@ [[mapping-fields]] -== Meta-Fields +== Metadata fields Each document has metadata associated with it, such as the `_index`, mapping -<>, and `_id` meta-fields. The behaviour of some of these meta-fields -can be customised when a mapping type is created. +<>, and `_id` metadata fields. The behavior of +some of these metadata fields can be customized when a mapping type is created. [discrete] -=== Identity meta-fields +=== Identity metadata fields [horizontal] <>:: @@ -22,7 +22,7 @@ can be customised when a mapping type is created. The document's ID. [discrete] -=== Document source meta-fields +=== Document source metadata fields <>:: @@ -34,7 +34,7 @@ can be customised when a mapping type is created. {plugins}/mapper-size.html[`mapper-size` plugin]. [discrete] -=== Indexing meta-fields +=== Indexing metadata fields <>:: @@ -46,14 +46,14 @@ can be customised when a mapping type is created. <>. [discrete] -=== Routing meta-field +=== Routing metadata field <>:: A custom routing value which routes a document to a particular shard. [discrete] -=== Other meta-field +=== Other metadata field <>:: diff --git a/docs/reference/mapping/removal_of_types.asciidoc b/docs/reference/mapping/removal_of_types.asciidoc index 8f6dd4c3f97..0901c682d2f 100644 --- a/docs/reference/mapping/removal_of_types.asciidoc +++ b/docs/reference/mapping/removal_of_types.asciidoc @@ -20,7 +20,7 @@ Each mapping type could have its own fields, so the `user` type might have a `tweet` type could have a `content` field, a `tweeted_at` field and, like the `user` type, a `user_name` field. -Each document had a `_type` meta-field containing the type name, and searches +Each document had a `_type` metadata field containing the type name, and searches could be limited to one or more types by specifying the type name(s) in the URL: diff --git a/docs/reference/migration/migrate_7_0/mappings.asciidoc b/docs/reference/migration/migrate_7_0/mappings.asciidoc index 63b16ebe9d1..0eb7b8c310b 100644 --- a/docs/reference/migration/migrate_7_0/mappings.asciidoc +++ b/docs/reference/migration/migrate_7_0/mappings.asciidoc @@ -11,13 +11,13 @@ [discrete] [[all-meta-field-removed]] -==== The `_all` meta field is removed +==== The `_all` metadata field is removed The `_all` field deprecated in 6 have now been removed. [discrete] [[uid-meta-field-removed]] -==== The `_uid` meta field is removed +==== The `_uid` metadata field is removed This field used to index a composite key formed of the `_type` and the `_id`. Now that indices cannot have multiple types, this has been removed in favour diff --git a/docs/reference/query-dsl/query_filter_context.asciidoc b/docs/reference/query-dsl/query_filter_context.asciidoc index 75290290c07..0aa0eb994cb 100644 --- a/docs/reference/query-dsl/query_filter_context.asciidoc +++ b/docs/reference/query-dsl/query_filter_context.asciidoc @@ -9,7 +9,7 @@ By default, Elasticsearch sorts matching search results by **relevance score**, which measures how well each document matches a query. The relevance score is a positive floating point number, returned in the -`_score` meta-field of the <> API. The higher the +`_score` metadata field of the <> API. The higher the `_score`, the more relevant the document. While each query type can calculate relevance scores differently, score calculation also depends on whether the query clause is run in a **query** or **filter** context. @@ -20,7 +20,7 @@ query clause is run in a **query** or **filter** context. In the query context, a query clause answers the question ``__How well does this document match this query clause?__'' Besides deciding whether or not the document matches, the query clause also calculates a relevance score in the -`_score` meta-field. +`_score` metadata field. Query context is in effect whenever a query clause is passed to a `query` parameter, such as the `query` parameter in the diff --git a/docs/reference/scripting/fields.asciidoc b/docs/reference/scripting/fields.asciidoc index 2aa3e2e6351..0e994d1048e 100644 --- a/docs/reference/scripting/fields.asciidoc +++ b/docs/reference/scripting/fields.asciidoc @@ -14,7 +14,7 @@ API will have access to the `ctx` variable which exposes: [horizontal] `ctx._source`:: Access to the document <>. `ctx.op`:: The operation that should be applied to the document: `index` or `delete`. -`ctx._index` etc:: Access to <>, some of which may be read-only. +`ctx._index` etc:: Access to <>, some of which may be read-only. [discrete] == Search and aggregation scripts diff --git a/docs/reference/search/suggesters/completion-suggest.asciidoc b/docs/reference/search/suggesters/completion-suggest.asciidoc index c8422b08e81..e64b7bf99cc 100644 --- a/docs/reference/search/suggesters/completion-suggest.asciidoc +++ b/docs/reference/search/suggesters/completion-suggest.asciidoc @@ -211,7 +211,7 @@ returns this response: // TESTRESPONSE[s/"took": 2,/"took": "$body.took",/] -IMPORTANT: `_source` meta-field must be enabled, which is the default +IMPORTANT: `_source` metadata field must be enabled, which is the default behavior, to enable returning `_source` with suggestions. The configured weight for a suggestion is returned as `_score`. The diff --git a/x-pack/docs/en/security/authorization/field-level-security.asciidoc b/x-pack/docs/en/security/authorization/field-level-security.asciidoc index 1db4333e6ab..60560e31f09 100644 --- a/x-pack/docs/en/security/authorization/field-level-security.asciidoc +++ b/x-pack/docs/en/security/authorization/field-level-security.asciidoc @@ -30,9 +30,9 @@ POST /_security/role/test_role1 } -------------------------------------------------- -Access to the following meta fields is always allowed: `_id`, +Access to the following metadata fields is always allowed: `_id`, `_type`, `_parent`, `_routing`, `_timestamp`, `_ttl`, `_size` and `_index`. If -you specify an empty list of fields, only these meta fields are accessible. +you specify an empty list of fields, only these metadata fields are accessible. NOTE: Omitting the fields entry entirely disables field level security.