Skip to content

Commit

Permalink
Improve Elasticsearch serverless APIs docs landing page (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
leemthompo authored Nov 21, 2024
1 parent 5c1d8fd commit 1680745
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 4 deletions.
33 changes: 30 additions & 3 deletions serverless/pages/apis-http-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,33 @@
// :description: {es} and {kib} expose REST APIs that can be called directly to configure and access {stack} features.
// :keywords: serverless, elasticsearch, http, rest, overview

* <<elasticsearch-api-conventions>>: The {es-serverless} REST APIs have conventions for headers and request bodies.
* <<elasticsearch-kibana-api-conventions>>: The Management APIs for {serverless-short} have request header conventions.
* https://www.elastic.co/docs/api/[API Reference]: Explore the reference information for Elastic Serverless REST APIs
[discrete]
[[elasticsearch-api-references-links]]
== API references

The following APIs are available for {es-serverless} users.
These links will take you to the autogenerated API reference documentation.

https://www.elastic.co/docs/api/doc/elasticsearch-serverless[Elasticsearch Serverless APIs →]::
Use these APIs to index, manage, search, and analyze your data in {es-serverless}.
+
[TIP]
====
Learn how to <<elasticsearch-connecting-to-es-serverless-endpoint,connect to your {es-serverless} endpoint>>.
====

https://www.elastic.co/docs/api/doc/serverless[Kibana Serverless APIs →]::
Use these APIs to manage resources such as connectors, data views, and saved objects for your {serverless-full} project.

https://www.elastic.co/docs/api/doc/elastic-cloud-serverless[{serverless-full} APIs →]::
Use these APIs to manage your {serverless-full} projects.

[discrete]
[[additional-api-details]]
== Additional API information

<<elasticsearch-api-conventions>>::
Reference information about headers and request body conventions for {es-serverless} REST APIs.

<<elasticsearch-kibana-api-conventions>>::
Reference information about request header conventions for {serverless-full} REST APIs.
5 changes: 5 additions & 0 deletions serverless/pages/clients.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ Currently, the following language clients are supported:
* <<elasticsearch-php-client-getting-started,PHP>> | https://github.com/elastic/elasticsearch-serverless-php[Repository]
* <<elasticsearch-python-client-getting-started,Python>> | https://github.com/elastic/elasticsearch-serverless-python[Repository]
* <<elasticsearch-ruby-client-getting-started,Ruby>> | https://github.com/elastic/elasticsearch-serverless-ruby[Repository]

[TIP]
====
Learn how to <<elasticsearch-connecting-to-es-serverless-endpoint,connect to your {es-serverless} endpoint>>.
====
5 changes: 4 additions & 1 deletion serverless/pages/connecting-to-es-endpoint.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[elasticsearch-connecting-to-es-serverless-endpoint]]
= Connecting to your Elasticsearch Serverless endpoint
= Connect to your Elasticsearch Serverless endpoint
++++
<titleabbrev>Connect to your endpoint</titleabbrev>
++++

[TIP]
====
Expand Down

0 comments on commit 1680745

Please sign in to comment.