From 603fbdcdf633c54aa3d5598c2ab090ed953a953b Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Fri, 6 Sep 2019 10:30:43 -0400 Subject: [PATCH] [DOCS] Resort common-parms (#46419) (#46442) --- docs/reference/rest-api/common-parms.asciidoc | 57 ++++++++----------- 1 file changed, 23 insertions(+), 34 deletions(-) diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index eba9904a78f01..e0ad283b38f63 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -194,16 +194,11 @@ tag::if_seq_no[] sequence number. See <>. 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`:: @@ -211,19 +206,6 @@ tag::include-defaults[] Defaults to `false`. end::include-defaults[] -tag::include-type-name[] -`include_type_name`:: -deprecated:[7.0.0, Mapping types have been deprecated. See <>.] -(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) @@ -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 <>.] +(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 @@ -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[] @@ -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 <> to be searchable. -end::segment-search[] - tag::search_timeout[] `search_timeout`:: (Optional, <> 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. 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 <> to be searchable. +end::segment-search[] + tag::settings[] `settings`:: (Optional, <>) Configuration