Skip to content

Commit

Permalink
[DOCS] Resort common-parms (#46419) (#46442)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Sep 6, 2019
1 parent 7c7fb7e commit 31b4e2f
Showing 1 changed file with 23 additions and 34 deletions.
57 changes: 23 additions & 34 deletions docs/reference/rest-api/common-parms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,36 +194,18 @@ tag::if_seq_no[]
sequence number. See <<optimistic-concurrency-control-index>>.
end::if_seq_no[]

tag::cat-h[]
`h`::
(Optional, string) Comma-separated list of column names to display.
end::cat-h[]

tag::help[]
`help`::
(Optional, boolean) If `true`, the response returns help information. Defaults
to `false`.
end::help[]
tag::index-ignore-unavailable[]
`ignore_unavailable`::
(Optional, boolean) If `true`, missing or closed indices are not included in the
response. Defaults to `false`.
end::index-ignore-unavailable[]

tag::include-defaults[]
`include_defaults`::
(Optional, string) If `true`, return all default settings in the response.
Defaults to `false`.
end::include-defaults[]

tag::include-type-name[]
`include_type_name`::
deprecated:[7.0.0, Mapping types have been deprecated. See <<removal-of-types>>.]
(Optional, boolean) If `true`, a mapping type is expected in the body of
mappings. Defaults to `false`.
end::include-type-name[]

tag::index-ignore-unavailable[]
`ignore_unavailable`::
(Optional, boolean) If `true`, missing or closed indices are not included in the
response. Defaults to `false`.
end::index-ignore-unavailable[]

tag::include-segment-file-sizes[]
`include_segment_file_sizes`::
(Optional, boolean)
Expand All @@ -232,6 +214,13 @@ each one of the Lucene index files (only applies if segment stats are
requested). Defaults to `false`.
end::include-segment-file-sizes[]

tag::include-type-name[]
`include_type_name`::
deprecated:[7.0.0, Mapping types have been deprecated. See <<removal-of-types>>.]
(Optional, boolean) If `true`, a mapping type is expected in the body of
mappings. Defaults to `false`.
end::include-type-name[]

tag::include-unloaded-segments[]
`include_unloaded_segments`::
(Optional, boolean) If `true`, the response includes information from segments
Expand Down Expand Up @@ -398,8 +387,8 @@ end::pipeline[]

tag::preference[]
`preference`::
(Optional, string) Specifies the node or shard the operation should be
performed on. Random by default.
(Optional, string) Specifies the node or shard the operation should be
performed on. Random by default.
end::preference[]

tag::search-q[]
Expand Down Expand Up @@ -457,15 +446,6 @@ tag::scroll_size[]
Defaults to 100.
end::scroll_size[]

tag::segment-search[]
If `true`,
the segment is searchable.
+
If `false`,
the segment has most likely been written to disk
but needs a <<indices-refresh,refresh>> to be searchable.
end::segment-search[]

tag::search_timeout[]
`search_timeout`::
(Optional, <<time-units, time units>> Explicit timeout for each search
Expand All @@ -485,6 +465,15 @@ the segment generation and used internally to create file names in the directory
of the shard.
end::segment[]

tag::segment-search[]
If `true`,
the segment is searchable.
+
If `false`,
the segment has most likely been written to disk
but needs a <<indices-refresh,refresh>> to be searchable.
end::segment-search[]

tag::settings[]
`settings`::
(Optional, <<index-modules-settings,index setting object>>) Configuration
Expand Down

0 comments on commit 31b4e2f

Please sign in to comment.