Skip to content

Commit

Permalink
[DOCS] Reformat freeze unfreeze APis to use new API format (elastic#4…
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Jul 8, 2019
1 parent a3b0562 commit bd2778c
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 43 deletions.
37 changes: 18 additions & 19 deletions docs/reference/indices/apis/freeze.asciidoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
[role="xpack"]
[testenv="basic"]
[[freeze-index-api]]
== Freeze index API
=== Freeze index API
++++
<titleabbrev>Freeze index</titleabbrev>
++++

Freezes an index.

[float]
=== Request
[[freeze-index-api-request]]
==== {api-request-title}

`POST /<index>/_freeze`

[float]
=== Description
//[[freeze-index-api-prereqs]]
//==== {api-prereq-title}

[[freeze-index-api-desc]]
==== {api-description-title}

A frozen index has almost no overhead on the cluster (except
for maintaining its metadata in memory), and is blocked for write operations.
See <<frozen-indices>> and <<unfreeze-index-api>>.

[float]
=== Path Parameters

`index` (required)::
(string) Identifier for the index
IMPORTANT: Freezing an index will close the index and reopen it within the same
API call. This causes primaries to not be allocated for a short amount of time
and causes the cluster to go red until the primaries are allocated again. This
limitation might be removed in the future.

//=== Query Parameters
[[freeze-index-api-path-parms]]
==== {api-path-parms-title}

//=== Authorization
`<index>` (Required)::
(string) Identifier for the index.

[float]
=== Examples
[[freeze-index-api-examples]]
==== {api-examples-title}

The following example freezes and unfreezes an index:

Expand All @@ -43,8 +47,3 @@ POST /my_index/_unfreeze
// CONSOLE
// TEST[s/^/PUT my_index\n/]

[IMPORTANT]
================================
Freezing an index will close the index and reopen it within the same API call. This causes primaries to not be allocated for a short
amount of time and causes the cluster to go red until the primaries are allocated again. This limitation might be removed in the future.
================================
11 changes: 11 additions & 0 deletions docs/reference/indices/apis/index.asciidoc
Original file line number Diff line number Diff line change
@@ -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[]
39 changes: 18 additions & 21 deletions docs/reference/indices/apis/unfreeze.asciidoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,40 @@
[role="xpack"]
[testenv="basic"]
[[unfreeze-index-api]]
== Unfreeze index API
=== Unfreeze index API
++++
<titleabbrev>Unfreeze index</titleabbrev>
++++

Unfreezes an index.

[float]
=== Request
[[unfreeze-index-api-request]]
==== {api-request-title}

`POST /<index>/_unfreeze`

[float]
=== Description
//[[unfreeze-index-api-prereqs]]
//==== {api-prereq-title}

[[unfreeze-index-api-desc]]
==== {api-description-title}

When a frozen index is unfrozen, the index goes through the normal recovery
process and becomes writeable again. See <<frozen-indices>> and <<freeze-index-api>>.

[float]
=== Path Parameters

`index` (required)::
(string) Identifier for the index
IMPORTANT: Freezing an index will close the index and reopen it within the same
API call. This causes primaries to not be allocated for a short amount of time
and causes the cluster to go red until the primaries are allocated again. This
limitation might be removed in the future.

[[unfreeze-index-api-path-parms]]
==== {api-path-parms-title}

//=== Query Parameters
`<index>` (Required)::
(string) Identifier for the index.

//=== Authorization

[float]
=== Examples
[[unfreeze-index-api-examples]]
==== {api-examples-title}

The following example freezes and unfreezes an index:

Expand All @@ -42,9 +45,3 @@ POST /my_index/_unfreeze
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT my_index\n/]

[IMPORTANT]
================================
Freezing an index will close the index and reopen it within the same API call. This causes primaries to not be allocated for a short
amount of time and causes the cluster to go red until the primaries are allocated again. This limitation might be removed in the future.
================================
5 changes: 2 additions & 3 deletions docs/reference/rest-api/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ not be included yet.
* <<ccr-apis,{ccr-cap} APIs>>
* <<data-frame-apis,{dataframe-cap} APIs>>
* <<graph-explore-api,Graph Explore API>>
* <<freeze-index-api>>, <<unfreeze-index-api>>
* <<index-apis>>
* <<indices-reload-analyzers,Reload Search Analyzers API>>
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
* <<licensing-apis,Licensing APIs>>
Expand All @@ -30,14 +30,13 @@ 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}/indices/apis/freeze.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[]
include::{es-repo-dir}/rollup/rollup-api.asciidoc[]
include::{xes-repo-dir}/rest-api/security.asciidoc[]
include::{es-repo-dir}/indices/apis/unfreeze.asciidoc[]
include::{xes-repo-dir}/rest-api/watcher.asciidoc[]
include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[]
include::defs.asciidoc[]

0 comments on commit bd2778c

Please sign in to comment.