Skip to content

Commit 0e8805c

Browse files
committed
[DOCS] Remove heading offsets for REST APIs (#44568)
Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
1 parent b893928 commit 0e8805c

File tree

120 files changed

+493
-495
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+493
-495
lines changed

docs/reference/api-conventions.asciidoc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[api-conventions]]
2-
= API conventions
2+
== API conventions
33

44
The *Elasticsearch* REST APIs are exposed using <<modules-http,JSON over HTTP>>.
55

@@ -12,7 +12,7 @@ API, unless otherwise specified.
1212
* <<url-access-control>>
1313

1414
[[multi-index]]
15-
== Multiple Indices
15+
=== Multiple Indices
1616

1717
Most APIs that refer to an `index` parameter support execution across multiple indices,
1818
using simple `test1,test2,test3` notation (or `_all` for all indices). It also
@@ -55,7 +55,7 @@ NOTE: Single index APIs such as the <<docs>> and the
5555
<<indices-aliases,single-index `alias` APIs>> do not support multiple indices.
5656

5757
[[date-math-index-names]]
58-
== Date math support in index names
58+
=== Date math support in index names
5959

6060
Date math index name resolution enables you to search a range of time-series indices, rather
6161
than searching all of your time-series indices and filtering the results or maintaining aliases.
@@ -164,12 +164,12 @@ GET /%3Clogstash-%7Bnow%2Fd-2d%7D%3E%2C%3Clogstash-%7Bnow%2Fd-1d%7D%3E%2C%3Clogs
164164
// TEST[s/now/2016.09.20||/]
165165

166166
[[common-options]]
167-
== Common options
167+
=== Common options
168168

169169
The following options can be applied to all of the REST APIs.
170170

171171
[float]
172-
=== Pretty Results
172+
==== Pretty Results
173173

174174
When appending `?pretty=true` to any request made, the JSON returned
175175
will be pretty formatted (use it for debugging only!). Another option is
@@ -178,7 +178,7 @@ to set `?format=yaml` which will cause the result to be returned in the
178178

179179

180180
[float]
181-
=== Human readable output
181+
==== Human readable output
182182

183183
Statistics are returned in a format suitable for humans
184184
(e.g. `"exists_time": "1h"` or `"size": "1kb"`) and for computers
@@ -191,7 +191,7 @@ consumption. The default for the `human` flag is
191191

192192
[[date-math]]
193193
[float]
194-
=== Date Math
194+
==== Date Math
195195

196196
Most parameters which accept a formatted date value -- such as `gt` and `lt`
197197
in <<query-dsl-range-query,`range` queries>>, or `from` and `to`
@@ -229,7 +229,7 @@ Assuming `now` is `2001-01-01 12:00:00`, some examples are:
229229

230230
[float]
231231
[[common-options-response-filtering]]
232-
=== Response Filtering
232+
==== Response Filtering
233233

234234
All REST APIs accept a `filter_path` parameter that can be used to reduce
235235
the response returned by Elasticsearch. This parameter takes a comma
@@ -396,7 +396,7 @@ GET /_search?filter_path=hits.hits._source&_source=title&sort=rating:desc
396396

397397

398398
[float]
399-
=== Flat Settings
399+
==== Flat Settings
400400

401401
The `flat_settings` flag affects rendering of the lists of settings. When the
402402
`flat_settings` flag is `true`, settings are returned in a flat format:
@@ -467,27 +467,27 @@ Returns:
467467
By default `flat_settings` is set to `false`.
468468

469469
[float]
470-
=== Parameters
470+
==== Parameters
471471

472472
Rest parameters (when using HTTP, map to HTTP URL parameters) follow the
473473
convention of using underscore casing.
474474

475475
[float]
476-
=== Boolean Values
476+
==== Boolean Values
477477

478478
All REST API parameters (both request parameters and JSON body) support
479479
providing boolean "false" as the value `false` and boolean "true" as the
480480
value `true`. All other values will raise an error.
481481

482482
[float]
483-
=== Number Values
483+
==== Number Values
484484

485485
All REST APIs support providing numbered parameters as `string` on top
486486
of supporting the native JSON number types.
487487

488488
[[time-units]]
489489
[float]
490-
=== Time units
490+
==== Time units
491491

492492
Whenever durations need to be specified, e.g. for a `timeout` parameter, the duration must specify
493493
the unit, like `2d` for 2 days. The supported units are:
@@ -503,7 +503,7 @@ the unit, like `2d` for 2 days. The supported units are:
503503

504504
[[byte-units]]
505505
[float]
506-
=== Byte size units
506+
==== Byte size units
507507

508508
Whenever the byte size of data needs to be specified, e.g. when setting a buffer size
509509
parameter, the value must specify the unit, like `10kb` for 10 kilobytes. Note that
@@ -519,7 +519,7 @@ these units use powers of 1024, so `1kb` means 1024 bytes. The supported units a
519519

520520
[[size-units]]
521521
[float]
522-
=== Unit-less quantities
522+
==== Unit-less quantities
523523

524524
Unit-less quantities means that they don't have a "unit" like "bytes" or "Hertz" or "meter" or "long tonne".
525525

@@ -535,7 +535,7 @@ when we mean 87 though. These are the supported multipliers:
535535

536536
[[distance-units]]
537537
[float]
538-
=== Distance Units
538+
==== Distance Units
539539

540540
Wherever distances need to be specified, such as the `distance` parameter in
541541
the <<query-dsl-geo-distance-query>>), the default unit is meters if none is specified.
@@ -557,7 +557,7 @@ Nautical mile:: `NM`, `nmi`, or `nauticalmiles`
557557

558558
[[fuzziness]]
559559
[float]
560-
=== Fuzziness
560+
==== Fuzziness
561561

562562
Some queries and APIs support parameters to allow inexact _fuzzy_ matching,
563563
using the `fuzziness` parameter.
@@ -590,7 +590,7 @@ the default values are 3 and 6, equivalent to `AUTO:3,6` that make for lengths:
590590

591591
[float]
592592
[[common-options-error-options]]
593-
=== Enabling stack traces
593+
==== Enabling stack traces
594594

595595
By default when a request returns an error Elasticsearch doesn't include the
596596
stack trace of the error. You can enable that behavior by setting the
@@ -668,7 +668,7 @@ The response looks like:
668668
// TESTRESPONSE[s/"stack_trace": "java.lang.Number.+\.\.\."/"stack_trace": $body.error.caused_by.stack_trace/]
669669

670670
[float]
671-
=== Request body in query string
671+
==== Request body in query string
672672

673673
For libraries that don't accept a request body for non-POST requests,
674674
you can pass the request body as the `source` query string parameter
@@ -677,7 +677,7 @@ should also be passed with a media type value that indicates the format
677677
of the source, such as `application/json`.
678678

679679
[float]
680-
=== Content-Type Requirements
680+
==== Content-Type Requirements
681681

682682
The type of the content sent in a request body must be specified using
683683
the `Content-Type` header. The value of this header must map to one of
@@ -690,7 +690,7 @@ content type must be specified using the `source_content_type` query
690690
string parameter.
691691

692692
[[url-access-control]]
693-
== URL-based access control
693+
=== URL-based access control
694694

695695
Many users use a proxy with URL-based access control to secure access to
696696
Elasticsearch indices. For <<search-multi-search,multi-search>>,

docs/reference/cat.asciidoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[[cat]]
2-
= cat APIs
2+
== cat APIs
33

44
["float",id="intro"]
5-
== Introduction
5+
=== Introduction
66

77
JSON is great... for computers. Even if it's pretty-printed, trying
88
to find relationships in the data is tedious. Human eyes, especially
@@ -15,11 +15,11 @@ the available commands.
1515

1616
[float]
1717
[[common-parameters]]
18-
== Common parameters
18+
=== Common parameters
1919

2020
[float]
2121
[[verbose]]
22-
=== Verbose
22+
==== Verbose
2323

2424
Each of the commands accepts a query string parameter `v` to turn on
2525
verbose output. For example:
@@ -41,7 +41,7 @@ u_n93zwxThWHi1PDBJAGAg 127.0.0.1 127.0.0.1 u_n93zw
4141

4242
[float]
4343
[[help]]
44-
=== Help
44+
==== Help
4545

4646
Each of the commands accepts a query string parameter `help` which will
4747
output its available columns. For example:
@@ -70,7 +70,7 @@ instead.
7070

7171
[float]
7272
[[headers]]
73-
=== Headers
73+
==== Headers
7474

7575
Each of the commands accepts a query string parameter `h` which forces
7676
only those columns to appear. For example:
@@ -95,7 +95,7 @@ with `queue`.
9595

9696
[float]
9797
[[numeric-formats]]
98-
=== Numeric formats
98+
==== Numeric formats
9999

100100
Many commands provide a few types of numeric output, either a byte, size
101101
or a time value. By default, these types are human-formatted,
@@ -126,7 +126,7 @@ If you want to change the <<size-units,size units>>, use `size` parameter.
126126
If you want to change the <<byte-units,byte units>>, use `bytes` parameter.
127127

128128
[float]
129-
=== Response as text, json, smile, yaml or cbor
129+
==== Response as text, json, smile, yaml or cbor
130130

131131
[source,sh]
132132
--------------------------------------------------
@@ -179,7 +179,7 @@ For example:
179179

180180
[float]
181181
[[sort]]
182-
=== Sort
182+
==== Sort
183183

184184
Each of the commands accepts a query string parameter `s` which sorts the table by
185185
the columns specified as the parameter value. Columns are specified either by name or by

docs/reference/cat/alias.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-alias]]
2-
== cat aliases
2+
=== cat aliases
33

44
`aliases` shows information about currently configured aliases to indices
55
including filter and routing infos.

docs/reference/cat/allocation.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-allocation]]
2-
== cat allocation
2+
=== cat allocation
33

44
`allocation` provides a snapshot of how many shards are allocated to each data node
55
and how much disk space they are using.

docs/reference/cat/count.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-count]]
2-
== cat count
2+
=== cat count
33

44
`count` provides quick access to the document count of the entire
55
cluster, or individual indices.

docs/reference/cat/fielddata.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-fielddata]]
2-
== cat fielddata
2+
=== cat fielddata
33

44
`fielddata` shows how much heap memory is currently being used by fielddata
55
on every data node in the cluster.

docs/reference/cat/health.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-health]]
2-
== cat health
2+
=== cat health
33

44
`health` is a terse, one-line representation of the same information
55
from `/_cluster/health`.
@@ -75,7 +75,7 @@ static, we would have an idea that there is a problem.
7575

7676
[float]
7777
[[timestamp]]
78-
=== Why the timestamp?
78+
==== Why the timestamp?
7979

8080
You typically are using the `health` command when a cluster is
8181
malfunctioning. During this period, it's extremely important to

docs/reference/cat/indices.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-indices]]
2-
== cat indices
2+
=== cat indices
33

44
The `indices` command provides a cross-section of each index. This
55
information *spans nodes*. For example:
@@ -37,15 +37,15 @@ is to use either the <<cat-count>> or the <<search-count>>
3737

3838
[float]
3939
[[pri-flag]]
40-
=== Primaries
40+
==== Primaries
4141

4242
The index stats by default will show them for all of an index's
4343
shards, including replicas. A `pri` flag can be supplied to enable
4444
the view of relevant stats in the context of only the primaries.
4545

4646
[float]
4747
[[examples]]
48-
=== Examples
48+
==== Examples
4949

5050
Which indices are yellow?
5151

docs/reference/cat/master.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-master]]
2-
== cat master
2+
=== cat master
33

44
`master` doesn't have any extra options. It simply displays the
55
master's node ID, bound IP address, and node name. For example:

docs/reference/cat/nodeattrs.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cat-nodeattrs]]
2-
== cat nodeattrs
2+
=== cat nodeattrs
33

44
The `nodeattrs` command shows custom node attributes.
55
For example:
@@ -32,7 +32,7 @@ and the `attr` and `value` columns give you the custom node attributes,
3232
one per line.
3333

3434
[float]
35-
=== Columns
35+
==== Columns
3636

3737
Below is an exhaustive list of the existing headers that can be
3838
passed to `nodeattrs?h=` to retrieve the relevant details in ordered

0 commit comments

Comments
 (0)