Skip to content

Commit 406d93f

Browse files
simon-dewtech-comm-team-couchbase
simon-dew
and
tech-comm-team-couchbase
authored
DOC-13306: Add documentation for indexer level scan timeout (#177)
* DOC-5669: Add indexer settings REST API * Add index batch size for rebalance * Add the default for `defer_build` * Default timeout for indexer * Update settings * Has examples and defaults * Add description * Add example titles * Update storage mode as a composite schema * Driveby: fix default preview config * Driveby: Update composed schema templates * Driveby: Add descriptions to REST API specs for composite schemas * Driveby: update overlay for Eventing REST API * Driveby: Include description for composite schemas * Driveby: fix maximum and minimum exclusives * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <[email protected]>
1 parent 221cd54 commit 406d93f

File tree

29 files changed

+3639
-67
lines changed

29 files changed

+3639
-67
lines changed

‎build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ defaultTasks 'admin:openApiGenerate',
2929
'eventing:openApiGenerate',
3030
'functions:openApiGenerate',
3131
'indexes:openApiGenerate',
32+
'index-settings:openApiGenerate',
3233
'search-index:openApiGenerate',
3334
'search-nodes:openApiGenerate',
3435
'search-advanced:openApiGenerate',

‎docs/modules/analytics-rest-links/attachments/analytics-links.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,7 @@ components:
826826

827827
ResponseAll:
828828
title: Links
829-
description: These properties are common to all links.
829+
description: Properties common to all links.
830830
type: object
831831
discriminator:
832832
propertyName: type
@@ -879,6 +879,7 @@ components:
879879

880880
ResponseCouchbaseSpecific:
881881
title: Couchbase Specific Response
882+
description: Properties specific to remote Couchbase links.
882883
type: object
883884
required:
884885
- activeHostname
@@ -1051,6 +1052,7 @@ components:
10511052

10521053
ResponseS3Specific:
10531054
title: S3 Specific Response
1055+
description: Properties specific to S3 links.
10541056
type: object
10551057
required:
10561058
- accessKeyId
@@ -1101,6 +1103,7 @@ components:
11011103

11021104
ResponseAzureBlobSpecific:
11031105
title: Azure Blob Specific Response
1106+
description: Properties specific to Azure Blob links.
11041107
type: object
11051108
required:
11061109
- endpoint
@@ -1205,6 +1208,7 @@ components:
12051208

12061209
ResponseGCSSpecific:
12071210
title: GCS Specific Response
1211+
description: Properties specific to Google Cloud Storage links.
12081212
type: object
12091213
required:
12101214
- applicationDefaultCredentials

‎docs/modules/analytics-rest-links/pages/index.adoc‎

Lines changed: 165 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4079,7 +4079,7 @@ endif::collapse-models[]
40794079

40804080
ifdef::model-descriptions[]
40814081
//tag::desc-ResponseAll[]
4082-
These properties are common to all links.
4082+
Properties common to all links.
40834083
//end::desc-ResponseAll[]
40844084
endif::model-descriptions[]
40854085

@@ -4199,15 +4199,48 @@ endif::collapse-models[]
41994199
.icon:bars[fw] Composite Schema
42004200
{blank}
42014201

4202-
All of the following:
4202+
//tag::ResponseAzureBlob[]
42034203

4204-
* xref:ResponseAll[]
4204+
ifdef::model-descriptions[]
4205+
//tag::desc-ResponseAzureBlob[]
4206+
These properties are returned for Azure Blob links.
4207+
//end::desc-ResponseAzureBlob[]
4208+
endif::model-descriptions[]
42054209

4210+
[cols="25,55,20",separator=¦]
4211+
|===
4212+
¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
4213+
4214+
a¦
4215+
a¦
42064216

4207-
* xref:ResponseAzureBlobSpecific[]
4217+
[markdown]
4218+
--
4219+
include::index.adoc[tag=desc-ResponseAll, opts=optional]
4220+
--
42084221

4222+
[%hardbreaks]
4223+
{blank}
4224+
a¦ xref:ResponseAll[]
42094225

42104226

4227+
a¦ _and_
4228+
a¦
4229+
4230+
[markdown]
4231+
--
4232+
include::index.adoc[tag=desc-ResponseAzureBlobSpecific, opts=optional]
4233+
--
4234+
4235+
[%hardbreaks]
4236+
{blank}
4237+
a¦ xref:ResponseAzureBlobSpecific[]
4238+
4239+
4240+
|===
4241+
4242+
//end::ResponseAzureBlob[]
4243+
42114244

42124245
// markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-end.adoc[opts=optional]
42134246

@@ -4238,6 +4271,11 @@ endif::collapse-models[]
42384271

42394272
//tag::ResponseAzureBlobSpecific[]
42404273

4274+
ifdef::model-descriptions[]
4275+
//tag::desc-ResponseAzureBlobSpecific[]
4276+
Properties specific to Azure Blob links.
4277+
//end::desc-ResponseAzureBlobSpecific[]
4278+
endif::model-descriptions[]
42414279

42424280
[cols="25,55,20",separator=¦]
42434281
|===
@@ -4446,15 +4484,48 @@ endif::collapse-models[]
44464484
.icon:bars[fw] Composite Schema
44474485
{blank}
44484486

4449-
All of the following:
4487+
//tag::ResponseCouchbase[]
44504488

4451-
* xref:ResponseAll[]
4489+
ifdef::model-descriptions[]
4490+
//tag::desc-ResponseCouchbase[]
4491+
These properties are returned for remote Couchbase links.
4492+
//end::desc-ResponseCouchbase[]
4493+
endif::model-descriptions[]
44524494

4495+
[cols="25,55,20",separator=¦]
4496+
|===
4497+
¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
4498+
4499+
a¦
4500+
a¦
44534501

4454-
* xref:ResponseCouchbaseSpecific[]
4502+
[markdown]
4503+
--
4504+
include::index.adoc[tag=desc-ResponseAll, opts=optional]
4505+
--
44554506

4507+
[%hardbreaks]
4508+
{blank}
4509+
a¦ xref:ResponseAll[]
44564510

44574511

4512+
a¦ _and_
4513+
a¦
4514+
4515+
[markdown]
4516+
--
4517+
include::index.adoc[tag=desc-ResponseCouchbaseSpecific, opts=optional]
4518+
--
4519+
4520+
[%hardbreaks]
4521+
{blank}
4522+
a¦ xref:ResponseCouchbaseSpecific[]
4523+
4524+
4525+
|===
4526+
4527+
//end::ResponseCouchbase[]
4528+
44584529

44594530
// markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-end.adoc[opts=optional]
44604531

@@ -4485,6 +4556,11 @@ endif::collapse-models[]
44854556

44864557
//tag::ResponseCouchbaseSpecific[]
44874558

4559+
ifdef::model-descriptions[]
4560+
//tag::desc-ResponseCouchbaseSpecific[]
4561+
Properties specific to remote Couchbase links.
4562+
//end::desc-ResponseCouchbaseSpecific[]
4563+
endif::model-descriptions[]
44884564

44894565
[cols="25,55,20",separator=¦]
44904566
|===
@@ -4952,15 +5028,48 @@ endif::collapse-models[]
49525028
.icon:bars[fw] Composite Schema
49535029
{blank}
49545030

4955-
All of the following:
5031+
//tag::ResponseGCS[]
49565032

4957-
* xref:ResponseAll[]
5033+
ifdef::model-descriptions[]
5034+
//tag::desc-ResponseGCS[]
5035+
These properties are returned for Google Cloud Storage links.
5036+
//end::desc-ResponseGCS[]
5037+
endif::model-descriptions[]
49585038

5039+
[cols="25,55,20",separator=¦]
5040+
|===
5041+
¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
5042+
5043+
a¦
5044+
a¦
49595045

4960-
* xref:ResponseGCSSpecific[]
5046+
[markdown]
5047+
--
5048+
include::index.adoc[tag=desc-ResponseAll, opts=optional]
5049+
--
49615050

5051+
[%hardbreaks]
5052+
{blank}
5053+
a¦ xref:ResponseAll[]
49625054

49635055

5056+
a¦ _and_
5057+
a¦
5058+
5059+
[markdown]
5060+
--
5061+
include::index.adoc[tag=desc-ResponseGCSSpecific, opts=optional]
5062+
--
5063+
5064+
[%hardbreaks]
5065+
{blank}
5066+
a¦ xref:ResponseGCSSpecific[]
5067+
5068+
5069+
|===
5070+
5071+
//end::ResponseGCS[]
5072+
49645073

49655074
// markup not found, no include::{specDir}definitions/ResponseGCS/definition-end.adoc[opts=optional]
49665075

@@ -4991,6 +5100,11 @@ endif::collapse-models[]
49915100

49925101
//tag::ResponseGCSSpecific[]
49935102

5103+
ifdef::model-descriptions[]
5104+
//tag::desc-ResponseGCSSpecific[]
5105+
Properties specific to Google Cloud Storage links.
5106+
//end::desc-ResponseGCSSpecific[]
5107+
endif::model-descriptions[]
49945108

49955109
[cols="25,55,20",separator=¦]
49965110
|===
@@ -5082,15 +5196,48 @@ endif::collapse-models[]
50825196
.icon:bars[fw] Composite Schema
50835197
{blank}
50845198

5085-
All of the following:
5199+
//tag::ResponseS3[]
50865200

5087-
* xref:ResponseAll[]
5201+
ifdef::model-descriptions[]
5202+
//tag::desc-ResponseS3[]
5203+
These properties are returned for S3 links.
5204+
//end::desc-ResponseS3[]
5205+
endif::model-descriptions[]
50885206

5207+
[cols="25,55,20",separator=¦]
5208+
|===
5209+
¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
5210+
5211+
a¦
5212+
a¦
50895213

5090-
* xref:ResponseS3Specific[]
5214+
[markdown]
5215+
--
5216+
include::index.adoc[tag=desc-ResponseAll, opts=optional]
5217+
--
50915218

5219+
[%hardbreaks]
5220+
{blank}
5221+
a¦ xref:ResponseAll[]
50925222

50935223

5224+
a¦ _and_
5225+
a¦
5226+
5227+
[markdown]
5228+
--
5229+
include::index.adoc[tag=desc-ResponseS3Specific, opts=optional]
5230+
--
5231+
5232+
[%hardbreaks]
5233+
{blank}
5234+
a¦ xref:ResponseS3Specific[]
5235+
5236+
5237+
|===
5238+
5239+
//end::ResponseS3[]
5240+
50945241

50955242
// markup not found, no include::{specDir}definitions/ResponseS3/definition-end.adoc[opts=optional]
50965243

@@ -5121,6 +5268,11 @@ endif::collapse-models[]
51215268

51225269
//tag::ResponseS3Specific[]
51235270

5271+
ifdef::model-descriptions[]
5272+
//tag::desc-ResponseS3Specific[]
5273+
Properties specific to S3 links.
5274+
//end::desc-ResponseS3Specific[]
5275+
endif::model-descriptions[]
51245276

51255277
[cols="25,55,20",separator=¦]
51265278
|===

‎docs/modules/analytics-rest-service/attachments/analytics-service.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ components:
132132
# Use YAML anchors for properties which are also available as query parameters
133133
ParametersCommon:
134134
title: Common Parameters
135+
description: Parameters common with the Query Service.
135136
type: object
136137
required:
137138
- statement
@@ -210,6 +211,7 @@ components:
210211
# Use YAML anchors for properties which are also available as query parameters
211212
ParametersLocal:
212213
title: Analytics Parameters
214+
description: Parameters specific to the Analytics Service.
213215
type: object
214216
properties:
215217
plan-format:
@@ -263,6 +265,7 @@ components:
263265
# For the Query Responses page
264266
ResponsesCommon:
265267
title: Common Responses
268+
description: Responses common with the Query Service.
266269
type: object
267270
properties:
268271
requestID:
@@ -328,6 +331,7 @@ components:
328331
# For the Query Responses page
329332
ResponsesLocal:
330333
title: Analytics Responses
334+
description: Responses specific to the Analytics Service.
331335
type: object
332336
properties:
333337
plans:

0 commit comments

Comments
 (0)