Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Move Elasticsearch APIs to REST APIs section. Add redirects. #44372

Merged
merged 2 commits into from
Jul 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/reference/api-conventions.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[[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
Expand All @@ -13,8 +11,6 @@ API, unless otherwise specified.
* <<common-options>>
* <<url-access-control>>

--

[[multi-index]]
== Multiple Indices

Expand Down
5 changes: 0 additions & 5 deletions docs/reference/cat.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
[[cat]]
= cat APIs

[partintro]
--

["float",id="intro"]
== Introduction

Expand Down Expand Up @@ -210,8 +207,6 @@ sushi_california_roll [*avocado*] 1 1
pizza_hawaiian [*pineapples*] 1
--------------------------------------------------

--

include::cat/alias.asciidoc[]

include::cat/allocation.asciidoc[]
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/cluster.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[[cluster]]
= Cluster APIs

[partintro]
--
["float",id="cluster-nodes"]
== Node specification

Expand Down Expand Up @@ -81,7 +79,6 @@ GET /_nodes/ra*:2
GET /_nodes/ra*:2*
--------------------------------------------------
// CONSOLE
--

include::cluster/health.asciidoc[]

Expand Down
5 changes: 0 additions & 5 deletions docs/reference/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
[[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:

Expand All @@ -23,8 +20,6 @@ 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[]
Expand Down
12 changes: 0 additions & 12 deletions docs/reference/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,8 @@ 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[]
Expand Down
15 changes: 10 additions & 5 deletions docs/reference/indices.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[[indices]]
= Indices APIs

[partintro]
--
The indices APIs are used to manage individual indices,
Index APIs are used to manage individual indices,
index settings, aliases, mappings, and index templates.

[float]
Expand All @@ -18,6 +16,9 @@ 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]]
Expand Down Expand Up @@ -57,8 +58,6 @@ index settings, aliases, mappings, and index templates.
* <<indices-flush>>
* <<indices-forcemerge>>

--

include::indices/create-index.asciidoc[]

include::indices/delete-index.asciidoc[]
Expand All @@ -75,6 +74,12 @@ 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[]
Expand Down
1 change: 1 addition & 0 deletions docs/reference/indices/analyze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ GET _analyze
--------------------------------------------------
// CONSOLE

[[explain-analyze-api]]
=== Explain Analyze

If you want to get more advanced details, set `explain` to `true` (defaults to `false`). It will output all token attributes for each token.
Expand Down
11 changes: 0 additions & 11 deletions docs/reference/indices/apis/index.asciidoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/indices/flush.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ POST _flush
// CONSOLE
// TEST[s/^/PUT kimchy\nPUT elasticsearch\n/]

[[indices-synced-flush]]
[[synced-flush-api]]
=== Synced Flush

Elasticsearch tracks the indexing activity of each shard. Shards that have not
Expand Down
137 changes: 136 additions & 1 deletion docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -640,11 +640,146 @@ See <<ml-get-filter>> and
See <<ml-get-calendar-event>> and
{stack-ov}/ml-calendars.html[Calendars and scheduled events].

[role="exclude",id="index-apis"]
=== Index APIs
{es} index APIs are now documented in <<indices>>.

[role="exclude",id="search-request-docvalue-fields"]
=== Doc value fields parameter for request body search API
See <<request-body-search-docvalue-fields>>.

[role="exclude",id="search-request-explain"]
=== Explain parameter for request body search API
See <<request-body-search-explain>>.

[role="exclude",id="search-request-collapse"]
=== Collapse parameter for request body search API
See <<request-body-search-collapse>>.

[role="exclude",id="search-request-from-size"]
=== From and size parameters for request body search API
See <<request-body-search-from-size>>.

[role="exclude",id="search-request-highlighting"]
=== Highlight parameter for request body search API
See <<request-body-search-highlighting>>.

[role="exclude",id="search-request-index-boost"]
=== Index boost parameter for request body search API
See <<request-body-search-index-boost>>.

[role="exclude",id="search-request-inner-hits"]
=== Inner hits parameter for request body search API
See <<request-body-search-inner-hits>>.

[role="exclude",id="search-request-min-score"]
=== Minimum score parameter for request body search API
See <<request-body-search-min-score>>.

[role="exclude",id="search-request-named-queries-and-filters"]
=== Named query parameter for request body search API
See <<request-body-search-queries-and-filters>>.

[role="exclude",id="search-request-post-filter"]
=== Post filter parameter for request body search API
See <<request-body-search-post-filter>>.

[role="exclude",id="search-request-preference"]
=== Preference parameter for request body search API
See <<request-body-search-preference>>.

[role="exclude",id="search-request-query"]
=== Query parameter for request body search API
See <<request-body-search-query>>.

[role="exclude",id="search-request-rescore"]
=== Rescoring parameter for request body search API
See <<request-body-search-rescore>>.

[role="exclude",id="search-request-script-fields"]
=== Script fields parameter for request body search API
See <<request-body-search-script-fields>>.

[role="exclude",id="search-request-scroll"]
=== Scroll parameter for request body search API
See <<request-body-search-scroll>>.

[role="exclude",id="search-request-search-after"]
=== Search after parameter for request body search API
See <<request-body-search-search-after>>.

[role="exclude",id="search-request-search-type"]
=== Search type parameter for request body search API
See <<request-body-search-search-type>>.

[role="exclude",id="search-request-seq-no-primary-term"]
=== Sequence numbers and primary terms parameter for request body search API
See <<request-body-search-search-type>>.

[role="exclude",id="search-request-sort"]
=== Sort parameter for request body search API
See <<request-body-search-sort>>.

[role="exclude",id="search-request-source-filtering"]
=== Source filtering parameter for request body search API
See <<request-body-search-source-filtering>>.

[role="exclude",id="search-request-stored-fields"]
=== Stored fields parameter for request body search API
See <<request-body-search-stored-fields>>.

[role="exclude",id="search-request-track-total-hits"]
=== Track total hits parameter for request body search API
See <<request-body-search-track-total-hits>>.

[role="exclude",id="search-request-version"]
=== Version parameter for request body search API
See <<request-body-search-version>>.

[role="exclude",id="search-suggesters-term"]
=== Term suggester
See <<term-suggester>>.

[role="exclude",id="search-suggesters-phrase"]
=== Phrase suggester
See <<phrase-suggester>>.

[role="exclude",id="search-suggesters-completion"]
=== Completion suggester
See <<completion-suggester>>.

[role="exclude",id="suggester-context"]
=== Context suggester
See <<context-suggester>>.

[role="exclude",id="returning-suggesters-type"]
=== Return suggester type
See <<return-suggesters-type>>.

[role="exclude",id="search-profile-queries"]
=== Profiling queries
See <<profiling-queries>>.

[role="exclude",id="search-profile-aggregations"]
=== Profiling aggregations
See <<profiling-aggregations>>.

[role="exclude",id="search-profile-considerations"]
=== Profiling considerations
See <<profiling-considerations>>.

[role="exclude",id="_explain_analyze"]
=== Explain analyze API
See <<explain-analyze-api>>.

[role="exclude",id="indices-synced-flush"]
=== Synced flush API
See <<synced-flush-api>>.

[role="exclude",id="_repositories"]
=== Snapshot repositories
See <<snapshots-repositories>>.

[role="exclude",id="_snapshot"]
=== Snapshot
See <<snapshots-take-snapshot>>.

15 changes: 13 additions & 2 deletions docs/reference/rest-api/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,15 @@ 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>>
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
Expand All @@ -26,14 +30,21 @@ 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}/ilm/apis/slm-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[]
Expand Down
5 changes: 0 additions & 5 deletions docs/reference/search.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
[[search]]
= Search APIs

[partintro]
--

Most search APIs are <<search-multi-index,multi-index>>, with the
exception of the <<search-explain>> endpoints.

Expand Down Expand Up @@ -160,8 +157,6 @@ 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[]
Expand Down
Loading