Skip to content
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.

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

[Backport 8.11] [DOCS] Separates sub-client sections to standalone pages #2379

Merged
merged 2 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
273 changes: 43 additions & 230 deletions docs/sphinx/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,237 +5,50 @@ Elasticsearch API Reference

All the API calls map the raw REST API as closely as possible, including the
distinction between required and optional arguments to the calls. Keyword
arguments are required for all
arguments are required for all calls.

.. note::

Some API parameters in Elasticsearch are reserved keywords in Python.
For example the ``from`` query parameter for pagination would be
aliased as ``from_``.


Elasticsearch
-------------

.. py:module:: elasticsearch

.. autoclass:: Elasticsearch
:members:

.. py:module:: elasticsearch.client

Async Search
------------

.. autoclass:: AsyncSearchClient
:members:

Autoscaling
-----------

.. autoclass:: AutoscalingClient
:members:

Cat
---

.. autoclass:: CatClient
:members:

Cross-Cluster Replication (CCR)
-------------------------------

.. autoclass:: CcrClient
:members:

Cluster
-------

.. autoclass:: ClusterClient
:members:

Dangling Indices
----------------

.. autoclass:: DanglingIndicesClient
:members:

Enrich Policies
---------------

.. autoclass:: EnrichClient
:members:

Event Query Language (EQL)
--------------------------

.. autoclass:: EqlClient
:members:

Snapshottable Features
----------------------

.. autoclass:: FeaturesClient
:members:

Fleet
-----

.. autoclass:: FleetClient
:members:

Graph Explore
-------------

.. autoclass:: GraphClient
:members:

Index Lifecycle Management (ILM)
--------------------------------

.. autoclass:: IlmClient
:members:

Indices
-------

.. autoclass:: IndicesClient
:members:

Ingest Pipelines
----------------

.. autoclass:: IngestClient
:members:

License
-------

.. autoclass:: LicenseClient
:members:

Logstash
--------

.. autoclass:: LogstashClient
:members:

Migration
---------

.. autoclass:: MigrationClient
:members:

Machine Learning (ML)
---------------------

.. autoclass:: MlClient
:members:

Monitoring
----------

.. autoclass:: MonitoringClient
:members:

Nodes
-----

.. autoclass:: NodesClient
:members:

Query rules
-----------

.. autoclass:: QueryRulesetClient
:members:

Rollup Indices
--------------

.. autoclass:: RollupClient
:members:

Search Applications
-------------------

.. autoclass:: SearchApplicationClient
:members:

Searchable Snapshots
--------------------

.. autoclass:: SearchableSnapshotsClient
:members:

Security
--------

.. autoclass:: SecurityClient
:members:

Shutdown
--------

.. autoclass:: ShutdownClient
:members:

Snapshot Lifecycle Management (SLM)
-----------------------------------

.. autoclass:: SlmClient
:members:

Snapshots
---------

.. autoclass:: SnapshotClient
:members:

SQL
---

.. autoclass:: SqlClient
:members:

Synonyms
--------

.. autoclass:: SynonymsClient
:members:

TLS/SSL
-------

.. autoclass:: SslClient
:members:

Tasks
-----

.. autoclass:: TasksClient
:members:

Text Structure
--------------

.. autoclass:: TextStructureClient
:members:

Transforms
----------

.. autoclass:: TransformClient
:members:

Watcher
-------

.. autoclass:: WatcherClient
:members:

X-Pack
------

.. autoclass:: XPackClient
:members:
For example the ``from`` query parameter for pagination would be aliased as
``from_``.

.. toctree::
:maxdepth: 1

api/elasticsearch
api/autoscaling
api/cat
api/ccr
api/cluster
api/dangling-indices
api/enrich-policies
api/eql
api/fleet
api/graph-explore
api/index-lifecycle-management
api/indices
api/ingest-pipelines
api/license
api/logstash
api/migration
api/ml
api/monitoring
api/nodes
api/query-rules
api/rollup-indices
api/search-application
api/searchable-snapshots
api/security
api/shutdown
api/snapshot-lifecycle-management
api/snapshots
api/snapshottable-features
api/sql
api/synonyms
api/tls-ssl
api/tasks
api/text-structure
api/transforms
api/watcher
api/x-pack
9 changes: 9 additions & 0 deletions docs/sphinx/api/autoscaling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _autoscaling:

Autoscaling
-----------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: AutoscalingClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/cat.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _cat:

Cat
---
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: CatClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/ccr.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _ccr:

Cross-Cluster Replication (CCR)
-------------------------------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: CcrClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/cluster.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _cluster:

Cluster
-------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: ClusterClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/dangling-indices.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _dangling-indices:

Dangling Indices
----------------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: DanglingIndicesClient
:members:
11 changes: 11 additions & 0 deletions docs/sphinx/api/elasticsearch.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _elasticsearch:

Elasticsearch
-------------

.. py:module:: elasticsearch

.. autoclass:: Elasticsearch
:members:

.. py:module:: elasticsearch.client
9 changes: 9 additions & 0 deletions docs/sphinx/api/enrich-policies.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _enrich-policies:

Enrich Policies
---------------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: EnrichClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/eql.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _eql:

Event Query Language (EQL)
--------------------------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: EqlClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/fleet.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _fleet:

Fleet
-----
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: FleetClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/graph-explore.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _graph-explore:

Graph Explore
-------------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: GraphClient
:members: