iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adds list to REST API reference page (#4128) 

* adds list to rest api reference page

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* tweaked wording

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* tweaks

Signed-off-by: Heather Halter <hdhalter@amazon.com>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
This commit is contained in:
Heather Halter 2023-05-19 11:33:20 -07:00 committed by GitHub
parent 4048d1237b
commit 190bdd75db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
_api-reference/index.md
View File

@ -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/)