From 190bdd75db555f571e2989368f656f6fddb93ae7 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Fri, 19 May 2023 11:33:20 -0700 Subject: [PATCH] Adds list to REST API reference page (#4128) * adds list to rest api reference page Signed-off-by: Heather Halter * tweaked wording Signed-off-by: Heather Halter * tweaks Signed-off-by: Heather Halter --------- Signed-off-by: Heather Halter --- _api-reference/index.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/_api-reference/index.md b/_api-reference/index.md index b53ad4ea..d32fc3d1 100644 --- a/_api-reference/index.md +++ b/_api-reference/index.md @@ -2,7 +2,8 @@ layout: default title: REST API reference nav_order: 1 -has_toc: true +has_toc: false +has_children: true nav_exclude: true redirect_from: - /opensearch/rest-api/index/ @@ -10,7 +11,35 @@ redirect_from: # REST API reference -OpenSearch uses its REST API for most operations. This _incomplete_ section includes REST API paths, HTTP verbs, supported parameters, request body details, and example responses. +You can use REST APIs for most operations in OpenSearch. In this reference, we provide a description of the API, and details that include the paths and HTTP methods, supported parameters, and example requests and responses. -In general, the OpenSearch REST API is no different from the Elasticsearch OSS REST API; most client code that worked with Elasticsearch OSS should also work with OpenSearch. +Most REST APIs supported by OpenSearch are included in this reference. If you know of any that are missing, feel free to enter feedback or submit a pull request. {: .tip } + +## Related articles + +- [Alias]({{site.url}}{{site.baseurl}}/api-reference/alias/) +- [Analyze API]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/index/) +- [CAT APIs]({{site.url}}{{site.baseurl}}/api-reference/cat/index/) +- [Cluster APIs]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/index/) +- [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters) +- [Count]({{site.url}}{{site.baseurl}}/api-reference/count/) +- [Document]({{site.url}}{{site.baseurl}}/api-reference/document-apis/index/) +- [Explain]({{site.url}}{{site.baseurl}}/api-reference/explain/) +- [Index APIs]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index/) +- [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/) +- [Multi-search]({{site.url}}{{site.baseurl}}/api-reference/multi-search/) +- [Nodes APIs]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/) +- [Popular APIs]({{site.url}}{{site.baseurl}}/api-reference/popular-api/) +- [Ranking evaluation]({{site.url}}{{site.baseurl}}/api-reference/rank-eval/) +- [Reload search analyzer]({{site.url}}{{site.baseurl}}/api-reference/reload-search-analyzer/) +- [Remove cluster information]({{site.url}}{{site.baseurl}}/api-reference/remote-info/) +- [Script APIs]({{site.url}}{{site.baseurl}}/api-reference/script-apis/index/) +- [Scroll]({{site.url}}{{site.baseurl}}/api-reference/scroll/) +- [Search]({{site.url}}{{site.baseurl}}/api-reference/search/) +- [Snapshot APIs]({{site.url}}{{site.baseurl}}/api-reference/snapshots/index/) +- [Supported units]({{site.url}}{{site.baseurl}}/api-reference/units/) +- [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks/) + + +