Browse Source

Revert "[DOCS] Relocate several APIs to REST APIs section (#44238)"

This reverts commit 6ebd59791afe2e0d55be2989fdbb594972237340.
James Rodewig 6 năm trước cách đây
mục cha
commit
3bdeb45ed7

+ 4 - 0
docs/reference/api-conventions.asciidoc

@@ -1,6 +1,8 @@
 [[api-conventions]]
 = API conventions
 
+[partintro]
+--
 The *Elasticsearch* REST APIs are exposed using <<modules-http,JSON over HTTP>>.
 
 The conventions listed in this chapter can be applied throughout the REST
@@ -11,6 +13,8 @@ API, unless otherwise specified.
 * <<common-options>>
 * <<url-access-control>>
 
+--
+
 [[multi-index]]
 == Multiple Indices
 

+ 5 - 0
docs/reference/cat.asciidoc

@@ -1,6 +1,9 @@
 [[cat]]
 = cat APIs
 
+[partintro]
+--
+
 ["float",id="intro"]
 == Introduction
 
@@ -207,6 +210,8 @@ sushi_california_roll [*avocado*]    1     1
 pizza_hawaiian        [*pineapples*] 1
 --------------------------------------------------
 
+--
+
 include::cat/alias.asciidoc[]
 
 include::cat/allocation.asciidoc[]

+ 3 - 0
docs/reference/cluster.asciidoc

@@ -1,6 +1,8 @@
 [[cluster]]
 = Cluster APIs
 
+[partintro]
+--
 ["float",id="cluster-nodes"]
 == Node specification
 
@@ -79,6 +81,7 @@ GET /_nodes/ra*:2
 GET /_nodes/ra*:2*
 --------------------------------------------------
 // CONSOLE
+--
 
 include::cluster/health.asciidoc[]
 

+ 5 - 0
docs/reference/docs.asciidoc

@@ -1,6 +1,9 @@
 [[docs]]
 = Document APIs
 
+[partintro]
+--
+
 This section starts with a short introduction to Elasticsearch's <<docs-replication,data replication model>>, followed by a
 detailed description of the following CRUD APIs:
 
@@ -20,6 +23,8 @@ detailed description of the following CRUD APIs:
 NOTE: All CRUD APIs are single-index APIs. The `index` parameter accepts a single
 index name, or an `alias` which points to a single index.
 
+--
+
 include::docs/data-replication.asciidoc[]
 
 include::docs/index_.asciidoc[]

+ 12 - 0
docs/reference/index.asciidoc

@@ -25,8 +25,20 @@ include::setup/bootstrap-checks-xes.asciidoc[]
 :edit_url:
 include::upgrade.asciidoc[]
 
+include::api-conventions.asciidoc[]
+
+include::docs.asciidoc[]
+
+include::search.asciidoc[]
+
 include::aggregations.asciidoc[]
 
+include::indices.asciidoc[]
+
+include::cat.asciidoc[]
+
+include::cluster.asciidoc[]
+
 include::query-dsl.asciidoc[]
 
 include::scripting.asciidoc[]

+ 5 - 10
docs/reference/indices.asciidoc

@@ -1,7 +1,9 @@
 [[indices]]
 = Indices APIs
 
-Index APIs are used to manage individual indices,
+[partintro]
+--
+The indices APIs are used to manage individual indices,
 index settings, aliases, mappings, and index templates.
 
 [float]
@@ -16,9 +18,6 @@ index settings, aliases, mappings, and index templates.
 * <<indices-shrink-index>>
 * <<indices-split-index>>
 * <<indices-rollover-index>>
-* <<freeze-index-api>>
-* <<unfreeze-index-api>>
-
 
 [float]
 [[mapping-management]]
@@ -58,6 +57,8 @@ index settings, aliases, mappings, and index templates.
 * <<indices-flush>>
 * <<indices-forcemerge>>
 
+--
+
 include::indices/create-index.asciidoc[]
 
 include::indices/delete-index.asciidoc[]
@@ -74,12 +75,6 @@ include::indices/split-index.asciidoc[]
 
 include::indices/rollover-index.asciidoc[]
 
-:leveloffset: -1
-include::indices/apis/freeze.asciidoc[]
-
-include::indices/apis/unfreeze.asciidoc[]
-
-:leveloffset: +1
 include::indices/put-mapping.asciidoc[]
 
 include::indices/get-mapping.asciidoc[]

+ 11 - 0
docs/reference/indices/apis/index.asciidoc

@@ -0,0 +1,11 @@
+[[index-apis]]
+== Index APIs
+
+The index APIs are used to manage individual indices.
+
+* <<freeze-index-api>>, <<unfreeze-index-api>>
+
+See also <<indices>>.
+
+include::freeze.asciidoc[]
+include::unfreeze.asciidoc[]

+ 1 - 5
docs/reference/redirects.asciidoc

@@ -620,8 +620,4 @@ without any configuration, if the total number of hits is not tracked.
 [role="exclude",id="xpack-api"]
 === X-Pack APIs
 
-{es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>. 
-
-[role="exclude",id="index-apis"]
-=== Index APIs
-{es} index APIs are now documented in <<indices>>.
+{es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>. 

+ 2 - 13
docs/reference/rest-api/index.asciidoc

@@ -10,15 +10,11 @@ directly to configure and access {es} features.
 We are working on including more {es} APIs in this section. Some content might
 not be included yet.
 
-* <<docs>>
-* <<search>>
-* <<indices>>
-* <<cat>>
-* <<cluster>>
 * <<info-api,Info API>>
 * <<ccr-apis,{ccr-cap} APIs>>
 * <<data-frame-apis,{dataframe-cap} APIs>>
 * <<graph-explore-api,Graph Explore API>>
+* <<index-apis>>
 * <<indices-reload-analyzers,Reload Search Analyzers API>>
 * <<index-lifecycle-management-api,Index lifecycle management APIs>>
 * <<licensing-apis,Licensing APIs>>
@@ -29,20 +25,13 @@ not be included yet.
 * <<migration-api,Migration APIs>>
 --
 
-:leveloffset: +1
-include::{es-repo-dir}/api-conventions.asciidoc[]
-include::{es-repo-dir}/docs.asciidoc[]
-include::{es-repo-dir}/search.asciidoc[]
-include::{es-repo-dir}/indices.asciidoc[]
-include::{es-repo-dir}/cat.asciidoc[]
-include::{es-repo-dir}/cluster.asciidoc[]
 
-:leveloffset: -1
 include::info.asciidoc[]
 include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[]
 include::{es-repo-dir}/data-frames/apis/index.asciidoc[]
 include::{es-repo-dir}/graph/explore.asciidoc[]
 include::{es-repo-dir}/ilm/apis/ilm-api.asciidoc[]
+include::{es-repo-dir}/indices/apis/index.asciidoc[]
 include::{es-repo-dir}/licensing/index.asciidoc[]
 include::{es-repo-dir}/migration/migration.asciidoc[]
 include::{es-repo-dir}/ml/apis/ml-api.asciidoc[]

+ 5 - 0
docs/reference/search.asciidoc

@@ -1,6 +1,9 @@
 [[search]]
 = Search APIs
 
+[partintro]
+--
+
 Most search APIs are <<search-multi-index,multi-index>>, with the
 exception of the <<search-explain>> endpoints.
 
@@ -157,6 +160,8 @@ overloading a cluster (e.g., a default request will hit all indices in a cluster
 which could cause shard request rejections if the number of shards per node is
 high). This default value is `5`.
 
+--
+
 include::search/search.asciidoc[]
 
 include::search/uri-request.asciidoc[]