Skip to content

Commit bfb2604

Browse files
simon-dewggray-cb
authored andcommitted
DOC-13306: Add documentation for indexer level scan timeout (#3863)
* Update Index REST API partial * Update Index REST API page * Update overall REST API intro page * Remove Modify Index Batch Size Page * Update nav
1 parent 1d665ac commit bfb2604

5 files changed

Lines changed: 34 additions & 63 deletions

File tree

modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ include::cli:partial$cbcli/nav.adoc[]
494494
*** xref:rest-api:get-settings-indexes.adoc[Retrieve GSI Settings]
495495
*** xref:rest-api:post-settings-indexes.adoc[Set GSI Settings]
496496
*** xref:index-rest-stats:index.adoc[Index Statistics API]
497-
*** xref:rest-api:rest-modify-index-batch-size.adoc[Modify Index Batch Size]
497+
*** xref:index-rest-settings:index.adoc[Index Settings API]
498498
499499
** xref:rest-api:backup-rest-api.adoc[Backup Service API]
500500
*** xref:rest-api:backup-create-and-edit-plans.adoc[Create and Edit Plans]
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
= Index Service API
2-
:description: The Index service REST API provides configuration options for the Index service.
2+
:description: The Index Service REST APIs provide configuration options for the Index Service.
33
:page-topic-type: reference
4+
:page-toclevels: 2
45
:page-aliases: rest-api:get-status-indexes.adoc,rest-api:get-statement-indexes.adoc
56

67
[abstract]
78
{description}
89

910
== APIs in this Section
1011

11-
The REST API allows Index-Service indexes to be created and managed.
12-
For a list of the methods and URIs covered in these pages, see the table below.
12+
For a list of the methods and URIs covered in these pages, see the tables below.
13+
14+
By default, the Index REST APIs below listen on port `9102`, or `19102` for secure access.
15+
Note that the GSI Settings API listens on port `8091`, or `18091` for secure access.
1316

1417
include::partial$rest-index-service-table.adoc[]

modules/rest-api/pages/rest-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ include::partial$rest-query-service-table.adoc[]
128128
== Index Service API
129129

130130
The _Index Service_ REST API provides configuration options for the Index Service.
131-
The API is listed below.
131+
The APIs are listed below.
132132

133133
include::partial$rest-index-service-table.adoc[]
134134

modules/rest-api/pages/rest-modify-index-batch-size.adoc

Lines changed: 0 additions & 58 deletions
This file was deleted.

modules/rest-api/partials/rest-index-service-table.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
=== GSI Settings
2+
13
[cols="2,7,6"]
24
|===
35
| HTTP Method | URI | Documented at
@@ -10,6 +12,14 @@
1012
| `/settings/indexes`
1113
| xref:rest-api:post-settings-indexes.adoc[Set GSI Settings]
1214

15+
|===
16+
17+
=== Index Statistics
18+
19+
[cols="2,7,6"]
20+
|===
21+
| HTTP Method | URI | Documented at
22+
1323
| `GET`
1424
| `/api/v1/stats`
1525
| xref:index-rest-stats:index.adoc#get_node_stats[Get Node Statistics]
@@ -23,3 +33,19 @@
2333
| xref:index-rest-stats:index.adoc#get_index_stats[Get Index Statistics]
2434

2535
|===
36+
37+
=== Index Settings
38+
39+
[cols="2,7,6"]
40+
|===
41+
| HTTP Method | URI | Documented at
42+
43+
| `GET`
44+
| `/settings`
45+
| xref:index-rest-settings:index.adoc#get_settings[Retrieve Index Settings]
46+
47+
| `POST`
48+
| `/settings`
49+
| xref:index-rest-settings:index.adoc#post_settings[Update Index Settings]
50+
51+
|===

0 commit comments

Comments
 (0)