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

78 lines
3.0 KiB
Plaintext
Raw Normal View History

[DOCS] Change 'X-Pack APIs' section to 'REST APIs' (#43451)
2019-06-26 13:44:33 -04:00
[[rest-apis]]
= REST APIs
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04:00
[partintro]
--
[DOCS] Change 'X-Pack APIs' section to 'REST APIs' (#43451)
2019-06-26 13:44:33 -04: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-05 19:43:55 -04: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-19 14:35:36 -04: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-01 15:43:44 -04: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-19 14:35:36 -04:00
* <<cat, cat APIs>>
* <<cluster, Cluster APIs>>
[DOCS] Replaces CCR terms with attributes (#39516)
2019-03-12 17:27:17 -04:00
* <<ccr-apis,{ccr-cap} APIs>>
[DOCS] Add data stream APIs to main API page (#58204) (#58325)
2020-06-18 09:41:43 -04:00
* <<data-stream-apis,Data stream 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-19 14:35:36 -04: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-04 14:11:52 -04:00
* <<enrich-apis,Enrich APIs>>
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04: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-19 14:35:36 -04: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-30 21:27:43 -04:00
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
[DOCS] Relocate Ingest API docs to REST API section (#45812)
2019-08-23 11:54:40 -04: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-19 14:35:36 -04:00
* <<info-api,Info API>>
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04:00
* <<licensing-apis,Licensing APIs>>
[DOCS] Separates data frame analytics APIs (#44451)
2019-07-16 16:22:27 -04: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-19 14:35:36 -04:00
* <<migration-api,Migration APIs>>
* <<indices-reload-analyzers,Reload Search Analyzers API>>
Add repositories metering API (#62088) This pull request adds a new set of APIs that allows tracking the number of requests performed by the different registered repositories. In order to avoid losing data, the repository statistics are archived after the repository is closed for a configurable retention period `repositories.stats.archive.retention_period`. The API exposes the statistics for the active repositories as well as the modified/closed repositories. Backport of #60371
2020-09-08 08:01:04 -04:00
* <<repositories-metering-apis,Repositories Metering 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-19 14:35:36 -04:00
* <<rollup-apis,Rollup APIs>>
* <<search, Search APIs>>
Merge feature/searchable-snapshots branch into 7.x (#54803) (#54825) This is a backport of #54803 for 7.x. This pull request cherry picks the squashed commit from #54803 with the additional commits: 6f50c92 which adjusts master code to 7.x a114549 to mute a failing ILM test (#54818) 48cbca1 and 50186b2 that cleans up and fixes the previous test aae12bb that adds a missing feature flag (#54861) 6f330e3 that adds missing serialization bits (#54864) bf72c02 that adjust the version in YAML tests a51955f that adds some plumbing for the transport client used in integration tests 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-07 07:28:53 -04:00
* <<searchable-snapshots-apis, Searchable snapshots APIs>>
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04:00
* <<security-api,Security APIs>>
[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 09:54:49 -04:00
* <<snapshot-restore-apis,Snapshot and restore 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-19 14:35:36 -04:00
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
[DOCS] Update data frame transform URLs (#46940) (#46946)
2019-09-20 18:57:43 -04:00
* <<transform-apis,{transform-cap} APIs>>
[7.x][DOCS] Adds X-Pack usage API (#52592)
2020-02-21 09:57:11 -05:00
* <<usage-api,Usage API>>
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04: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 08:49:22 -04: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-01 15:43:44 -04: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-06 21:55:01 -05: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-01 15:43:44 -04: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 08:49:22 -04: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 11:23:35 -04:00
include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[]
[DOCS] Reformat data streams intro and overview (#57954) (#57993) Changes: * Updates 'Data streams' intro page to focus on problem solution and benefits. * Adds 'Data streams overview' page to cover conceptual information, based on existing content in the 'Data streams' intro. * Adds diagrams for data streams and search/indexing request examples. * Moves API jump list and API docs to a new 'Data streams APIs' section. Links to these APIs will be available through tutorials. * Add xrefs to existing docs for concepts like generation, write index, and append-only.
2020-06-11 11:32:09 -04:00
include::{es-repo-dir}/data-streams/data-stream-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-19 14:35:36 -04: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-04 14:11:52 -04:00
include::{es-repo-dir}/ingest/apis/enrich/index.asciidoc[]
[DOCS] Moves graph to docs folder (#33472)
2018-09-26 17:59:31 -04: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-19 14:35:36 -04: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-30 21:27:43 -04:00
include::{es-repo-dir}/ilm/apis/ilm-api.asciidoc[]
[DOCS] Relocate Ingest API docs to REST API section (#45812)
2019-08-23 11:54:40 -04: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-19 14:35:36 -04:00
include::info.asciidoc[]
[DOCS] Move licensing APIs to docs (#31445)
2018-06-20 11:17:11 -04:00
include::{es-repo-dir}/licensing/index.asciidoc[]
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59928)
2020-07-20 16:10:54 -04:00
include::{es-repo-dir}/ml/anomaly-detection/apis/index.asciidoc[]
[DOCS] Separates data frame analytics APIs (#44451)
2019-07-16 16:22:27 -04: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-19 14:35:36 -04:00
include::{es-repo-dir}/migration/migration.asciidoc[]
include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[]
Add repositories metering API (#62088) This pull request adds a new set of APIs that allows tracking the number of requests performed by the different registered repositories. In order to avoid losing data, the repository statistics are archived after the repository is closed for a configurable retention period `repositories.stats.archive.retention_period`. The API exposes the statistics for the active repositories as well as the modified/closed repositories. Backport of #60371
2020-09-08 08:01:04 -04:00
include::{es-repo-dir}/repositories-metering-api/repositories-metering-apis.asciidoc[]
[DOCS] Move rollup APIs to docs (#31450)
2018-08-31 13:50:43 -04: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-19 14:35:36 -04:00
include::{es-repo-dir}/search.asciidoc[]
Suppress searchable snapshots docs in releases (#58652) This commit adds conditional logic to the docs to avoid including any docs on searchable snapshots in released versions. Rework of #58556 which was reverted.
2020-06-30 07:24:35 -04:00
ifdef::permanently-unreleased-branch[]
Merge feature/searchable-snapshots branch into 7.x (#54803) (#54825) This is a backport of #54803 for 7.x. This pull request cherry picks the squashed commit from #54803 with the additional commits: 6f50c92 which adjusts master code to 7.x a114549 to mute a failing ILM test (#54818) 48cbca1 and 50186b2 that cleans up and fixes the previous test aae12bb that adds a missing feature flag (#54861) 6f330e3 that adds missing serialization bits (#54864) bf72c02 that adjust the version in YAML tests a51955f that adds some plumbing for the transport client used in integration tests 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-07 07:28:53 -04:00
include::{es-repo-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[]
Suppress searchable snapshots docs in releases (#58652) This commit adds conditional logic to the docs to avoid including any docs on searchable snapshots in released versions. Rework of #58556 which was reverted.
2020-06-30 07:24:35 -04:00
endif::[]
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04:00
include::{xes-repo-dir}/rest-api/security.asciidoc[]
[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 09:54:49 -04:00
include::{es-repo-dir}/snapshot-restore/apis/snapshot-restore-apis.asciidoc[]
Backporting updates to ILM org, overview, & GS (#51898) * [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Fixed glossary merge error. Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-02-04 19:45:18 -05:00
include::{es-repo-dir}/slm/apis/slm-api.asciidoc[]
[DOCS] Removes data-frames folder (#46760)
2019-09-16 13:23:46 -04:00
include::{es-repo-dir}/transform/apis/index.asciidoc[]
[7.x][DOCS] Adds X-Pack usage API (#52592)
2020-02-21 09:57:11 -05:00
include::usage.asciidoc[]
[DOCS] Creates rest-api folder in docs
2018-06-05 19:43:55 -04:00
include::{xes-repo-dir}/rest-api/watcher.asciidoc[]
[DOCS] Moves machine learning APIs to docs folder (#31118)
2018-08-31 19:49:24 -04:00
include::defs.asciidoc[]