honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Resort common-parms (#46419) (#46442)

This commit is contained in:
James Rodewig 2019-09-06 10:30:43 -04:00 committed by GitHub
parent 7c7fb7e32d
commit 31b4e2f6df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/reference/rest-api/common-parms.asciidoc
View File

@ -194,16 +194,11 @@ tag::if_seq_no[]
sequence number. See <<optimistic-concurrency-control-index>>. sequence number. See <<optimistic-concurrency-control-index>>.
end::if_seq_no[] end::if_seq_no[]
tag::cat-h[] tag::index-ignore-unavailable[]
`h`:: `ignore_unavailable`::
(Optional, string) Comma-separated list of column names to display. (Optional, boolean) If `true`, missing or closed indices are not included in the
end::cat-h[] response. Defaults to `false`.
end::index-ignore-unavailable[]
tag::help[]
`help`::
(Optional, boolean) If `true`, the response returns help information. Defaults
to `false`.
end::help[]
tag::include-defaults[] tag::include-defaults[]
`include_defaults`:: `include_defaults`::
@ -211,19 +206,6 @@ tag::include-defaults[]
Defaults to `false`. Defaults to `false`.
end::include-defaults[] 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[] tag::include-segment-file-sizes[]
`include_segment_file_sizes`:: `include_segment_file_sizes`::
(Optional, boolean) (Optional, boolean)
@ -232,6 +214,13 @@ each one of the Lucene index files (only applies if segment stats are
requested). Defaults to `false`. requested). Defaults to `false`.
end::include-segment-file-sizes[] 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[] tag::include-unloaded-segments[]
`include_unloaded_segments`:: `include_unloaded_segments`::
(Optional, boolean) If `true`, the response includes information from segments (Optional, boolean) If `true`, the response includes information from segments
@ -457,15 +446,6 @@ tag::scroll_size[]
Defaults to 100. Defaults to 100.
end::scroll_size[] 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[] tag::search_timeout[]
`search_timeout`:: `search_timeout`::
(Optional, <<time-units, time units>> Explicit timeout for each search (Optional, <<time-units, time units>> Explicit timeout for each search
@ -485,6 +465,15 @@ the segment generation and used internally to create file names in the directory
of the shard. of the shard.
end::segment[] 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[] tag::settings[]
`settings`:: `settings`::
(Optional, <<index-modules-settings,index setting object>>) Configuration (Optional, <<index-modules-settings,index setting object>>) Configuration