DOC-13306: Add documentation for indexer level scan timeout

build.gradle

@@ -29,6 +29,7 @@ defaultTasks 'admin:openApiGenerate',
              'eventing:openApiGenerate',
              'functions:openApiGenerate',
              'indexes:openApiGenerate',
+             'index-settings:openApiGenerate',
              'search-index:openApiGenerate',
              'search-nodes:openApiGenerate',
              'search-advanced:openApiGenerate',

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

@@ -826,7 +826,7 @@ components:
 
   ResponseAll:
     title: Links
-    description: These properties are common to all links.
+    description: Properties common to all links.
     type: object
     discriminator:
       propertyName: type
@@ -879,6 +879,7 @@ components:
 
   ResponseCouchbaseSpecific:
         title: Couchbase Specific Response
+        description: Properties specific to remote Couchbase links.
         type: object
         required:
           - activeHostname
@@ -1051,6 +1052,7 @@ components:
 
   ResponseS3Specific:
         title: S3 Specific Response
+        description: Properties specific to S3 links.
         type: object
         required:
           - accessKeyId
@@ -1101,6 +1103,7 @@ components:
 
   ResponseAzureBlobSpecific:
         title: Azure Blob Specific Response
+        description: Properties specific to Azure Blob links.
         type: object
         required:
           - endpoint
@@ -1205,6 +1208,7 @@ components:
 
   ResponseGCSSpecific:
         title: GCS Specific Response
+        description: Properties specific to Google Cloud Storage links.
         type: object
         required:
           - applicationDefaultCredentials

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

@@ -4079,7 +4079,7 @@ endif::collapse-models[]
 
 ifdef::model-descriptions[]
 //tag::desc-ResponseAll[]
-These properties are common to all links.
+Properties common to all links.
 //end::desc-ResponseAll[]
 endif::model-descriptions[]
 
@@ -4199,15 +4199,48 @@ endif::collapse-models[]
 .icon:bars[fw] Composite Schema
 {blank}
 
-All of the following:
+//tag::ResponseAzureBlob[]
 
-* xref:ResponseAll[]
+ifdef::model-descriptions[]
+//tag::desc-ResponseAzureBlob[]
+These properties are returned for Azure Blob links.
+//end::desc-ResponseAzureBlob[]
+endif::model-descriptions[]
 
+[cols="25,55,20",separator=¦]
+|===
+¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
+
+a¦ 
+a¦ 
 
-* xref:ResponseAzureBlobSpecific[]
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseAll, opts=optional]
+--
 
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseAll[]
 
 
+a¦ _and_
+a¦ 
+
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseAzureBlobSpecific, opts=optional]
+--
+
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseAzureBlobSpecific[]
+
+
+|===
+
+//end::ResponseAzureBlob[]
+
 
 // markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-end.adoc[opts=optional]
 
@@ -4238,6 +4271,11 @@ endif::collapse-models[]
 
 //tag::ResponseAzureBlobSpecific[]
 
+ifdef::model-descriptions[]
+//tag::desc-ResponseAzureBlobSpecific[]
+Properties specific to Azure Blob links.
+//end::desc-ResponseAzureBlobSpecific[]
+endif::model-descriptions[]
 
 [cols="25,55,20",separator=¦]
 |===
@@ -4446,15 +4484,48 @@ endif::collapse-models[]
 .icon:bars[fw] Composite Schema
 {blank}
 
-All of the following:
+//tag::ResponseCouchbase[]
 
-* xref:ResponseAll[]
+ifdef::model-descriptions[]
+//tag::desc-ResponseCouchbase[]
+These properties are returned for remote Couchbase links.
+//end::desc-ResponseCouchbase[]
+endif::model-descriptions[]
 
+[cols="25,55,20",separator=¦]
+|===
+¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
+
+a¦ 
+a¦ 
 
-* xref:ResponseCouchbaseSpecific[]
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseAll, opts=optional]
+--
 
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseAll[]
 
 
+a¦ _and_
+a¦ 
+
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseCouchbaseSpecific, opts=optional]
+--
+
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseCouchbaseSpecific[]
+
+
+|===
+
+//end::ResponseCouchbase[]
+
 
 // markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-end.adoc[opts=optional]
 
@@ -4485,6 +4556,11 @@ endif::collapse-models[]
 
 //tag::ResponseCouchbaseSpecific[]
 
+ifdef::model-descriptions[]
+//tag::desc-ResponseCouchbaseSpecific[]
+Properties specific to remote Couchbase links.
+//end::desc-ResponseCouchbaseSpecific[]
+endif::model-descriptions[]
 
 [cols="25,55,20",separator=¦]
 |===
@@ -4952,15 +5028,48 @@ endif::collapse-models[]
 .icon:bars[fw] Composite Schema
 {blank}
 
-All of the following:
+//tag::ResponseGCS[]
 
-* xref:ResponseAll[]
+ifdef::model-descriptions[]
+//tag::desc-ResponseGCS[]
+These properties are returned for Google Cloud Storage links.
+//end::desc-ResponseGCS[]
+endif::model-descriptions[]
 
+[cols="25,55,20",separator=¦]
+|===
+¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
+
+a¦ 
+a¦ 
 
-* xref:ResponseGCSSpecific[]
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseAll, opts=optional]
+--
 
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseAll[]
 
 
+a¦ _and_
+a¦ 
+
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseGCSSpecific, opts=optional]
+--
+
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseGCSSpecific[]
+
+
+|===
+
+//end::ResponseGCS[]
+
 
 // markup not found, no include::{specDir}definitions/ResponseGCS/definition-end.adoc[opts=optional]
 
@@ -4991,6 +5100,11 @@ endif::collapse-models[]
 
 //tag::ResponseGCSSpecific[]
 
+ifdef::model-descriptions[]
+//tag::desc-ResponseGCSSpecific[]
+Properties specific to Google Cloud Storage links.
+//end::desc-ResponseGCSSpecific[]
+endif::model-descriptions[]
 
 [cols="25,55,20",separator=¦]
 |===
@@ -5082,15 +5196,48 @@ endif::collapse-models[]
 .icon:bars[fw] Composite Schema
 {blank}
 
-All of the following:
+//tag::ResponseS3[]
 
-* xref:ResponseAll[]
+ifdef::model-descriptions[]
+//tag::desc-ResponseS3[]
+These properties are returned for S3 links.
+//end::desc-ResponseS3[]
+endif::model-descriptions[]
 
+[cols="25,55,20",separator=¦]
+|===
+¦ All{nbsp}of{nbsp}... ¦ ¦ Schema
+
+a¦ 
+a¦ 
 
-* xref:ResponseS3Specific[]
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseAll, opts=optional]
+--
 
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseAll[]
 
 
+a¦ _and_
+a¦ 
+
+[markdown]
+--
+include::index.adoc[tag=desc-ResponseS3Specific, opts=optional]
+--
+
+[%hardbreaks]
+{blank}
+a¦ xref:ResponseS3Specific[]
+
+
+|===
+
+//end::ResponseS3[]
+
 
 // markup not found, no include::{specDir}definitions/ResponseS3/definition-end.adoc[opts=optional]
 
@@ -5121,6 +5268,11 @@ endif::collapse-models[]
 
 //tag::ResponseS3Specific[]
 
+ifdef::model-descriptions[]
+//tag::desc-ResponseS3Specific[]
+Properties specific to S3 links.
+//end::desc-ResponseS3Specific[]
+endif::model-descriptions[]
 
 [cols="25,55,20",separator=¦]
 |===

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

@@ -132,6 +132,7 @@ components:
   # Use YAML anchors for properties which are also available as query parameters
   ParametersCommon:
     title: Common Parameters
+    description: Parameters common with the Query Service.
     type: object
     required:
       - statement
@@ -210,6 +211,7 @@ components:
   # Use YAML anchors for properties which are also available as query parameters
   ParametersLocal:
     title: Analytics Parameters
+    description: Parameters specific to the Analytics Service.
     type: object
     properties:
       plan-format:
@@ -263,6 +265,7 @@ components:
   # For the Query Responses page
   ResponsesCommon:
         title: Common Responses
+        description: Responses common with the Query Service.
         type: object
         properties:
           requestID:
@@ -328,6 +331,7 @@ components:
   # For the Query Responses page
   ResponsesLocal:
         title: Analytics Responses
+        description: Responses specific to the Analytics Service.
         type: object
         properties:
           plans: