Skip to content

Improve Elasticsearch serverless APIs docs landing page #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 21, 2024
Merged

Improve Elasticsearch serverless APIs docs landing page #207

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ebe886
Improve Elasticsearch serverless APIs docs landing page
leemthompo Nov 20, 2024
d3e8840
Add TIP with link to finding connection details
leemthompo Nov 20, 2024
62ca64b
Add tip to clients overview page
leemthompo Nov 20, 2024
e17a8df
Drive-by heading abbreviation
leemthompo Nov 20, 2024
b25fde7
Merge branch 'main' into refactor-api-page
leemthompo Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions serverless/pages/apis-http-apis.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,33 @@

preview:[]

* <<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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,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
View file
Open in desktop
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