Skip to content

Commit 5ac6428

Browse files
szabostevepquentin
szabosteve
and
pquentin
authored
[DOCS] Separate sub-client sections to standalone pages (#2375)
Co-authored-by: Quentin Pradet <[email protected]>
1 parent f0374b4 commit 5ac6428

39 files changed

+373
-230
lines changed

‎docs/sphinx/api.rst

Lines changed: 43 additions & 230 deletions
Original file line numberDiff line numberDiff line change
@@ -5,237 +5,50 @@ Elasticsearch API Reference
55

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

1010
.. note::
1111

1212
Some API parameters in Elasticsearch are reserved keywords in Python.
13-
For example the ``from`` query parameter for pagination would be
14-
aliased as ``from_``.
15-
16-
17-
Elasticsearch
18-
-------------
19-
20-
.. py:module:: elasticsearch
21-
22-
.. autoclass:: Elasticsearch
23-
:members:
24-
25-
.. py:module:: elasticsearch.client
26-
27-
Async Search
28-
------------
29-
30-
.. autoclass:: AsyncSearchClient
31-
:members:
32-
33-
Autoscaling
34-
-----------
35-
36-
.. autoclass:: AutoscalingClient
37-
:members:
38-
39-
Cat
40-
---
41-
42-
.. autoclass:: CatClient
43-
:members:
44-
45-
Cross-Cluster Replication (CCR)
46-
-------------------------------
47-
48-
.. autoclass:: CcrClient
49-
:members:
50-
51-
Cluster
52-
-------
53-
54-
.. autoclass:: ClusterClient
55-
:members:
56-
57-
Dangling Indices
58-
----------------
59-
60-
.. autoclass:: DanglingIndicesClient
61-
:members:
62-
63-
Enrich Policies
64-
---------------
65-
66-
.. autoclass:: EnrichClient
67-
:members:
68-
69-
Event Query Language (EQL)
70-
--------------------------
71-
72-
.. autoclass:: EqlClient
73-
:members:
74-
75-
Snapshottable Features
76-
----------------------
77-
78-
.. autoclass:: FeaturesClient
79-
:members:
80-
81-
Fleet
82-
-----
83-
84-
.. autoclass:: FleetClient
85-
:members:
86-
87-
Graph Explore
88-
-------------
89-
90-
.. autoclass:: GraphClient
91-
:members:
92-
93-
Index Lifecycle Management (ILM)
94-
--------------------------------
95-
96-
.. autoclass:: IlmClient
97-
:members:
98-
99-
Indices
100-
-------
101-
102-
.. autoclass:: IndicesClient
103-
:members:
104-
105-
Ingest Pipelines
106-
----------------
107-
108-
.. autoclass:: IngestClient
109-
:members:
110-
111-
License
112-
-------
113-
114-
.. autoclass:: LicenseClient
115-
:members:
116-
117-
Logstash
118-
--------
119-
120-
.. autoclass:: LogstashClient
121-
:members:
122-
123-
Migration
124-
---------
125-
126-
.. autoclass:: MigrationClient
127-
:members:
128-
129-
Machine Learning (ML)
130-
---------------------
131-
132-
.. autoclass:: MlClient
133-
:members:
134-
135-
Monitoring
136-
----------
137-
138-
.. autoclass:: MonitoringClient
139-
:members:
140-
141-
Nodes
142-
-----
143-
144-
.. autoclass:: NodesClient
145-
:members:
146-
147-
Query rules
148-
-----------
149-
150-
.. autoclass:: QueryRulesetClient
151-
:members:
152-
153-
Rollup Indices
154-
--------------
155-
156-
.. autoclass:: RollupClient
157-
:members:
158-
159-
Search Applications
160-
-------------------
161-
162-
.. autoclass:: SearchApplicationClient
163-
:members:
164-
165-
Searchable Snapshots
166-
--------------------
167-
168-
.. autoclass:: SearchableSnapshotsClient
169-
:members:
170-
171-
Security
172-
--------
173-
174-
.. autoclass:: SecurityClient
175-
:members:
176-
177-
Shutdown
178-
--------
179-
180-
.. autoclass:: ShutdownClient
181-
:members:
182-
183-
Snapshot Lifecycle Management (SLM)
184-
-----------------------------------
185-
186-
.. autoclass:: SlmClient
187-
:members:
188-
189-
Snapshots
190-
---------
191-
192-
.. autoclass:: SnapshotClient
193-
:members:
194-
195-
SQL
196-
---
197-
198-
.. autoclass:: SqlClient
199-
:members:
200-
201-
Synonyms
202-
--------
203-
204-
.. autoclass:: SynonymsClient
205-
:members:
206-
207-
TLS/SSL
208-
-------
209-
210-
.. autoclass:: SslClient
211-
:members:
212-
213-
Tasks
214-
-----
215-
216-
.. autoclass:: TasksClient
217-
:members:
218-
219-
Text Structure
220-
--------------
221-
222-
.. autoclass:: TextStructureClient
223-
:members:
224-
225-
Transforms
226-
----------
227-
228-
.. autoclass:: TransformClient
229-
:members:
230-
231-
Watcher
232-
-------
233-
234-
.. autoclass:: WatcherClient
235-
:members:
236-
237-
X-Pack
238-
------
239-
240-
.. autoclass:: XPackClient
241-
:members:
13+
For example the ``from`` query parameter for pagination would be aliased as
14+
``from_``.
15+
16+
.. toctree::
17+
:maxdepth: 1
18+
19+
api/elasticsearch
20+
api/autoscaling
21+
api/cat
22+
api/ccr
23+
api/cluster
24+
api/dangling-indices
25+
api/enrich-policies
26+
api/eql
27+
api/fleet
28+
api/graph-explore
29+
api/index-lifecycle-management
30+
api/indices
31+
api/ingest-pipelines
32+
api/license
33+
api/logstash
34+
api/migration
35+
api/ml
36+
api/monitoring
37+
api/nodes
38+
api/query-rules
39+
api/rollup-indices
40+
api/search-application
41+
api/searchable-snapshots
42+
api/security
43+
api/shutdown
44+
api/snapshot-lifecycle-management
45+
api/snapshots
46+
api/snapshottable-features
47+
api/sql
48+
api/synonyms
49+
api/tls-ssl
50+
api/tasks
51+
api/text-structure
52+
api/transforms
53+
api/watcher
54+
api/x-pack

‎docs/sphinx/api/autoscaling.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _autoscaling:
2+
3+
Autoscaling
4+
-----------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: AutoscalingClient
9+
:members:

‎docs/sphinx/api/cat.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _cat:
2+
3+
Cat
4+
---
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: CatClient
9+
:members:

‎docs/sphinx/api/ccr.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _ccr:
2+
3+
Cross-Cluster Replication (CCR)
4+
-------------------------------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: CcrClient
9+
:members:

‎docs/sphinx/api/cluster.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _cluster:
2+
3+
Cluster
4+
-------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: ClusterClient
9+
:members:

‎docs/sphinx/api/dangling-indices.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _dangling-indices:
2+
3+
Dangling Indices
4+
----------------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: DanglingIndicesClient
9+
:members:

‎docs/sphinx/api/elasticsearch.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _elasticsearch:
2+
3+
Elasticsearch
4+
-------------
5+
6+
.. py:module:: elasticsearch
7+
8+
.. autoclass:: Elasticsearch
9+
:members:
10+
11+
.. py:module:: elasticsearch.client

‎docs/sphinx/api/enrich-policies.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _enrich-policies:
2+
3+
Enrich Policies
4+
---------------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: EnrichClient
9+
:members:

‎docs/sphinx/api/eql.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _eql:
2+
3+
Event Query Language (EQL)
4+
--------------------------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: EqlClient
9+
:members:

‎docs/sphinx/api/fleet.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _fleet:
2+
3+
Fleet
4+
-----
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: FleetClient
9+
:members:

‎docs/sphinx/api/graph-explore.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _graph-explore:
2+
3+
Graph Explore
4+
-------------
5+
.. py:module:: elasticsearch.client
6+
:noindex:
7+
8+
.. autoclass:: GraphClient
9+
:members:

0 commit comments

Comments
 (0)