root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/rest-api/index.asciidoc

70 lines
2.6 KiB
Plaintext
Raw Normal View History

[DOCS] Change 'X-Pack APIs' section to 'REST APIs' (#43451)
2019-06-27 01:44:33 +08:00
[[rest-apis]]
= REST APIs
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
[partintro]
--
[DOCS] Change 'X-Pack APIs' section to 'REST APIs' (#43451)
2019-06-27 01:44:33 +08:00
{es} exposes REST APIs that are used by the UI components and can be called
directly to configure and access {es} features.
[NOTE]
We are working on including more {es} APIs in this section. Some content might
not be included yet.
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
[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.
2019-07-20 02:35:36 +08:00
* <<api-conventions, API conventions>>
Include autoscaling APIs in API docs (#54603) This commit adds a top-level link to the autoscaling API reference page to the API docs. Additionally, we add a conditional guard on the API pages to only include them in development builds of the docs.
2020-04-02 03:43:44 +08:00
ifdef::permanently-unreleased-branch[]
* <<autoscaling-apis, Autoscaling APIs>>
endif::[]
[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.
2019-07-20 02:35:36 +08:00
* <<cat, cat APIs>>
* <<cluster, Cluster APIs>>
[DOCS] Replaces CCR terms with attributes (#39516)
2019-03-13 05:27:17 +08:00
* <<ccr-apis,{ccr-cap} APIs>>
[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.
2019-07-20 02:35:36 +08:00
* <<docs, Document APIs>>
[DOCS] Separate Enrich API Docs (#46286) * Add enrich policy common parameter * Add enrich APIs to REST APIs index * Add put enrich policy API docs * Add get enrich policy API docs * Add delete enrich policy API docs * Add execute enrich policy API docs
2019-09-05 02:11:52 +08:00
* <<enrich-apis,Enrich APIs>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<graph-explore-api,Graph Explore API>>
[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.
2019-07-20 02:35:36 +08:00
* <<indices, Index APIs>>
[DOCS] Fixed edit links for ILM APIs and added the APIs to the REST ref (#35070) * [DOCS] Fixed edit links for ILM APIs and added the APIs to the REST API section. * [DOCS] Fixed link to ILM APIs.
2018-10-31 09:27:43 +08:00
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
[DOCS] Relocate Ingest API docs to REST API section (#45812)
2019-08-23 23:54:40 +08:00
* <<ingest-apis,Ingest APIs>>
[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.
2019-07-20 02:35:36 +08:00
* <<info-api,Info API>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<licensing-apis,Licensing APIs>>
[DOCS] Separates data frame analytics APIs (#44451) * [DOCS] Separates data frame analytics APIs * [DOCS] Adds links between new pages
2019-07-17 04:22:27 +08:00
* <<ml-apis,{ml-cap} {anomaly-detect} APIs>>
* <<ml-df-analytics-apis,{ml-cap} {dfanalytics} APIs>>
[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.
2019-07-20 02:35:36 +08:00
* <<migration-api,Migration APIs>>
* <<indices-reload-analyzers,Reload Search Analyzers API>>
* <<rollup-apis,Rollup APIs>>
* <<search, Search APIs>>
Merge feature/searchable-snapshots branch into master (#54803) This commit merges the searchable-snapshots feature branch into master. See #54803 for the complete list of squashed commits. Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Yannick Welsch <yannick@welsch.lu> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
2020-04-06 21:51:05 +08:00
* <<searchable-snapshots-apis, Searchable snapshots APIs>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<security-api,Security APIs>>
[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.
2019-07-20 02:35:36 +08:00
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
[DOCS] Update data frame transform URLs (#46940)
2019-09-21 04:26:57 +08:00
* <<transform-apis,{transform-cap} APIs>>
[DOCS] Adds X-Pack usage API (#52496)
2020-02-21 01:25:57 +08:00
* <<usage-api,Usage API>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<watcher-api,Watcher APIs>>
--
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 20:49:22 +08:00
include::{es-repo-dir}/api-conventions.asciidoc[]
Include autoscaling APIs in API docs (#54603) This commit adds a top-level link to the autoscaling API reference page to the API docs. Additionally, we add a conditional guard on the API pages to only include them in development builds of the docs.
2020-04-02 03:43:44 +08:00
ifdef::permanently-unreleased-branch[]
Add autoscaling API skelton (#51564) The main purpose of this commit is to add a single autoscaling REST endpoint skeleton, for the purpose of starting to build out the build and testing infrastructure that will surround it. For example, rather than commiting a fully-functioning autoscaling API, we introduce here the skeleton so that we can start wiring up the build and testing infrastructure, establish security roles/permissions, an so on. This way, in a forthcoming PR that introduces actual functionality, that PR will be smaller and have less distractions around that sort of infrastructure.
2020-02-07 08:15:17 +08:00
include::{es-repo-dir}/autoscaling/apis/autoscaling-apis.asciidoc[]
Include autoscaling APIs in API docs (#54603) This commit adds a top-level link to the autoscaling API reference page to the API docs. Additionally, we add a conditional guard on the API pages to only include them in development builds of the docs.
2020-04-02 03:43:44 +08:00
endif::[]
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 20:49:22 +08:00
include::{es-repo-dir}/cat.asciidoc[]
include::{es-repo-dir}/cluster.asciidoc[]
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 23:23:35 +08:00
include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[]
[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.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/docs.asciidoc[]
[DOCS] Separate Enrich API Docs (#46286) * Add enrich policy common parameter * Add enrich APIs to REST APIs index * Add put enrich policy API docs * Add get enrich policy API docs * Add delete enrich policy API docs * Add execute enrich policy API docs
2019-09-05 02:11:52 +08:00
include::{es-repo-dir}/ingest/apis/enrich/index.asciidoc[]
[DOCS] Moves graph to docs folder (#33472)
2018-09-27 05:59:31 +08:00
include::{es-repo-dir}/graph/explore.asciidoc[]
[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.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/indices.asciidoc[]
[DOCS] Fixed edit links for ILM APIs and added the APIs to the REST ref (#35070) * [DOCS] Fixed edit links for ILM APIs and added the APIs to the REST API section. * [DOCS] Fixed link to ILM APIs.
2018-10-31 09:27:43 +08:00
include::{es-repo-dir}/ilm/apis/ilm-api.asciidoc[]
[DOCS] Relocate Ingest API docs to REST API section (#45812)
2019-08-23 23:54:40 +08:00
include::{es-repo-dir}/ingest/apis/index.asciidoc[]
[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.
2019-07-20 02:35:36 +08:00
include::info.asciidoc[]
[DOCS] Move licensing APIs to docs (#31445)
2018-06-20 23:17:11 +08:00
include::{es-repo-dir}/licensing/index.asciidoc[]
[DOCS] Moves content to ML anomaly-detection folder (#44520)
2019-07-18 04:48:12 +08:00
include::{es-repo-dir}/ml/anomaly-detection/apis/ml-api.asciidoc[]
[DOCS] Separates data frame analytics APIs (#44451) * [DOCS] Separates data frame analytics APIs * [DOCS] Adds links between new pages
2019-07-17 04:22:27 +08:00
include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[]
[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.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/migration/migration.asciidoc[]
include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[]
[DOCS] Move rollup APIs to docs (#31450)
2018-09-01 01:50:43 +08:00
include::{es-repo-dir}/rollup/rollup-api.asciidoc[]
[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.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/search.asciidoc[]
Merge feature/searchable-snapshots branch into master (#54803) This commit merges the searchable-snapshots feature branch into master. See #54803 for the complete list of squashed commits. Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Yannick Welsch <yannick@welsch.lu> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
2020-04-06 21:51:05 +08:00
include::{es-repo-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[]
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
include::{xes-repo-dir}/rest-api/security.asciidoc[]
[DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-22 11:58:17 +08:00
include::{es-repo-dir}/slm/apis/slm-api.asciidoc[]
[DOCS] Removes data-frames folder (#46760)
2019-09-17 01:23:46 +08:00
include::{es-repo-dir}/transform/apis/index.asciidoc[]
[DOCS] Adds X-Pack usage API (#52496)
2020-02-21 01:25:57 +08:00
include::usage.asciidoc[]
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
include::{xes-repo-dir}/rest-api/watcher.asciidoc[]
[DOCS] Moves machine learning APIs to docs folder (#31118)
2018-09-01 07:49:24 +08:00
include::defs.asciidoc[]