Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ include::cli:partial$cbcli/nav.adoc[]
*** xref:rest-api:get-settings-indexes.adoc[Retrieve GSI Settings]
*** xref:rest-api:post-settings-indexes.adoc[Set GSI Settings]
*** xref:index-rest-stats:index.adoc[Index Statistics API]
*** xref:rest-api:rest-modify-index-batch-size.adoc[Modify Index Batch Size]
*** xref:index-rest-settings:index.adoc[Index Settings API]

** xref:rest-api:backup-rest-api.adoc[Backup Service API]
*** xref:rest-api:backup-create-and-edit-plans.adoc[Create and Edit Plans]
Expand Down
9 changes: 6 additions & 3 deletions modules/rest-api/pages/rest-index-service.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
= Index Service API
:description: The Index service REST API provides configuration options for the Index service.
:description: The Index Service REST APIs provide configuration options for the Index Service.
:page-topic-type: reference
:page-toclevels: 2
:page-aliases: rest-api:get-status-indexes.adoc,rest-api:get-statement-indexes.adoc

[abstract]
{description}

== APIs in this Section

The REST API allows Index-Service indexes to be created and managed.
For a list of the methods and URIs covered in these pages, see the table below.
For a list of the methods and URIs covered in these pages, see the tables below.

By default, the Index REST APIs below listen on port `9102`, or `19102` for secure access.
Note that the GSI Settings API listens on port `8091`, or `18091` for secure access.

include::partial$rest-index-service-table.adoc[]
2 changes: 1 addition & 1 deletion modules/rest-api/pages/rest-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ include::partial$rest-query-service-table.adoc[]
== Index Service API

The _Index Service_ REST API provides configuration options for the Index Service.
The API is listed below.
The APIs are listed below.

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

Expand Down
58 changes: 0 additions & 58 deletions modules/rest-api/pages/rest-modify-index-batch-size.adoc

This file was deleted.

26 changes: 26 additions & 0 deletions modules/rest-api/partials/rest-index-service-table.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== GSI Settings

[cols="2,7,6"]
|===
| HTTP Method | URI | Documented at
Expand All @@ -10,6 +12,14 @@
| `/settings/indexes`
| xref:rest-api:post-settings-indexes.adoc[Set GSI Settings]

|===

=== Index Statistics

[cols="2,7,6"]
|===
| HTTP Method | URI | Documented at

| `GET`
| `/api/v1/stats`
| xref:index-rest-stats:index.adoc#get_node_stats[Get Node Statistics]
Expand All @@ -23,3 +33,19 @@
| xref:index-rest-stats:index.adoc#get_index_stats[Get Index Statistics]

|===

=== Index Settings

[cols="2,7,6"]
|===
| HTTP Method | URI | Documented at

| `GET`
| `/settings`
| xref:index-rest-settings:index.adoc#get_settings[Retrieve Index Settings]

| `POST`
| `/settings`
| xref:index-rest-settings:index.adoc#post_settings[Update Index Settings]

|===