DOC-13516: Update Morpheus REST API builds (#182)

simon-dew · dgnicholson · commit 91d8e4595d27 · 2025-10-21T13:51:03.000-03:00
* Update remote gradle builds for Morpheus
* Fix template for additional properties name
* Driveby: Analytics additional property names
* Build output documentation
diff --git a/docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml b/docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Analytics Administration REST APIs
-  version: capella
+  version: "8.0"
   description: |
     The Analytics Administration REST APIs are provided by the Analytics service.
     These APIs enables you to manage and monitor the Analytics service.
@@ -606,6 +606,7 @@ components:
           landmark: 7
 
   MutationsColl:
+        x-additionalPropertiesName: scope
         type: object
         description: >
           An object containing one or more collection properties, one for each Analytics collection in the Analytics scope.
@@ -615,6 +616,7 @@ components:
           For example, `` `travel-sample`.inventory ``.
         title: Collections
         additionalProperties:
+            x-additionalPropertiesName: collection
             type: integer
             description: >
               The number of mutations in the DCP queue that have not yet been ingested.
diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc
@@ -33,7 +33,7 @@ These APIs enables you to manage and monitor the Analytics service.
 [discrete#version]
 = Version information
 [%hardbreaks]
-__Version__ : capella
+__Version__ : 8.0
 
 [discrete#host]
 = Host information
@@ -2016,7 +2016,7 @@ endif::model-descriptions[]
 ¦ Property ¦ ¦ Schema
 
 a¦ 
-
+*<scope>* +
 _additional +
 property_
 a¦ 
@@ -2081,7 +2081,7 @@ endif::model-descriptions[]
 ¦ Property ¦ ¦ Schema
 
 a¦ 
-
+*<collection>* +
 _additional +
 property_
 a¦ 
diff --git a/docs/modules/analytics-rest-config/attachments/analytics-config.yaml b/docs/modules/analytics-rest-config/attachments/analytics-config.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Analytics Configuration REST API
-  version: capella
+  version: "8.0"
   description: |
     The Analytics Configuration REST API is provided by the Analytics service.
     This API enables you to configure Analytics nodes and clusters.
diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc
@@ -33,7 +33,7 @@ This API enables you to configure Analytics nodes and clusters.
 [discrete#version]
 = Version information
 [%hardbreaks]
-__Version__ : capella
+__Version__ : 8.0
 
 [discrete#host]
 = Host information
diff --git a/docs/modules/analytics-rest-links/attachments/analytics-links.yaml b/docs/modules/analytics-rest-links/attachments/analytics-links.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Analytics Links REST API
-  version: capella
+  version: "8.0"
   description: |-
     The Analytics Links REST API is provided by the Analytics service.
     This API enables you to manage the links to remote Couchbase clusters and external data sources.
diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc
@@ -32,7 +32,7 @@ This API enables you to manage the links to remote Couchbase clusters and extern
 [discrete#version]
 = Version information
 [%hardbreaks]
-__Version__ : capella
+__Version__ : 8.0
 
 [discrete#host]
 = Host information
diff --git a/docs/modules/analytics-rest-service/attachments/analytics-service.yaml b/docs/modules/analytics-rest-service/attachments/analytics-service.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Analytics Service REST API
-  version: capella
+  version: "8.0"
   description: |
     The Analytics Service REST API is provided by the Analytics service.
     This API enables you to run Analytics queries and set request-level parameters.
@@ -205,6 +205,7 @@ components:
         description: An array of positional parameter values.
         items: {}
     additionalProperties:
+        x-additionalPropertiesName: '$identifier'
         description: A named parameter value.
 
   # For the Query Parameters page
diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc
@@ -33,7 +33,7 @@ This API enables you to run Analytics queries and set request-level parameters.
 [discrete#version]
 = Version information
 [%hardbreaks]
-__Version__ : capella
+__Version__ : 8.0
 
 [discrete#host]
 = Host information
@@ -1271,7 +1271,7 @@ a¦ Any Type
  array
 
 a¦ 
-
+*<$identifier>* +
 _additional +
 property_
 a¦ 
diff --git a/docs/modules/analytics-rest-settings/attachments/analytics-settings.yaml b/docs/modules/analytics-rest-settings/attachments/analytics-settings.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Analytics Settings REST API
-  version: capella
+  version: "8.0"
   description: |
     The Analytics Settings REST API is provided by the Analytics service.
     This API enables you to view or set cluster-level Analytics settings.
diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc
@@ -33,7 +33,7 @@ This API enables you to view or set cluster-level Analytics settings.
 [discrete#version]
 = Version information
 [%hardbreaks]
-__Version__ : capella
+__Version__ : 8.0
 
 [discrete#host]
 = Host information
diff --git a/docs/modules/eventing-rest-api/attachments/eventing.yaml b/docs/modules/eventing-rest-api/attachments/eventing.yaml
@@ -891,7 +891,7 @@ components:
           x-has-default: true
           description: |-
             Enables the Eventing service debugger.
-            For details, see [Debugging and Diagnosability](/server/8.0/eventing/eventing-debugging-and-diagnosability.html).
+            For details, see [Debugging and Diagnosability](/cloud/eventing/eventing-debugging-and-diagnosability.html).
         cursor_limit:
           type: integer
           default: 5
diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc
@@ -8636,7 +8636,7 @@ a¦
 [markdown]
 --
 Enables the Eventing service debugger.
-For details, see [Debugging and Diagnosability](/server/8.0/eventing/eventing-debugging-and-diagnosability.html).
+For details, see [Debugging and Diagnosability](/cloud/eventing/eventing-debugging-and-diagnosability.html).
 --
 
 [%hardbreaks]
diff --git a/docs/modules/fts-rest-advanced/search-advanced.gradle b/docs/modules/fts-rest-advanced/search-advanced.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/master/docs/spec/advanced/advanced.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/advanced/advanced.yaml"
     outputDir = "${rootDir}/docs/modules/fts-rest-advanced/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cbft"
diff --git a/docs/modules/fts-rest-indexing/search-index.gradle b/docs/modules/fts-rest-indexing/search-index.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/master/docs/spec/index/index.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/index/index.yaml"
     outputDir = "${rootDir}/docs/modules/fts-rest-indexing/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cbft"
diff --git a/docs/modules/fts-rest-manage/search-manage.gradle b/docs/modules/fts-rest-manage/search-manage.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/master/docs/spec/manage/manage.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/manage/manage.yaml"
     outputDir = "${rootDir}/docs/modules/fts-rest-manage/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cbft"
diff --git a/docs/modules/fts-rest-nodes/search-nodes.gradle b/docs/modules/fts-rest-nodes/search-nodes.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/master/docs/spec/nodes/nodes.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/nodes/nodes.yaml"
     outputDir = "${rootDir}/docs/modules/fts-rest-nodes/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cbft"
diff --git a/docs/modules/fts-rest-query/search-query.gradle b/docs/modules/fts-rest-query/search-query.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/master/docs/spec/query/query.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/query/query.yaml"
     outputDir = "${rootDir}/docs/modules/fts-rest-query/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cbft"
diff --git a/docs/modules/fts-rest-stats/search-stats.gradle b/docs/modules/fts-rest-stats/search-stats.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/master/docs/spec/stats/stats.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/stats/stats.yaml"
     outputDir = "${rootDir}/docs/modules/fts-rest-stats/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cbft"
diff --git a/docs/modules/index-rest-stats/attachments/indexes.yaml b/docs/modules/index-rest-stats/attachments/indexes.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Index Statistics REST API
-  version: capella
+  version: "8.0"
   description: |-
     The Index Statistics REST API is provided by the Index service.
     This API enables you to get Index service statistics.
diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc
@@ -32,7 +32,7 @@ This API enables you to get Index service statistics.
 [discrete#version]
 = Version information
 [%hardbreaks]
-__Version__ : capella
+__Version__ : 8.0
 
 [discrete#host]
 = Host information
diff --git a/docs/modules/n1ql-rest-admin/admin.gradle b/docs/modules/n1ql-rest-admin/admin.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/master/docs/spec/admin/admin.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/admin/admin.yaml"
     outputDir = "${rootDir}/docs/modules/n1ql-rest-admin/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "query"
diff --git a/docs/modules/n1ql-rest-admin/attachments/_admin.yaml b/docs/modules/n1ql-rest-admin/attachments/_admin.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Query Admin REST API
-  version: capella
+  version: "8.0"
   description: |-
     The Query Admin REST API is a secondary API provided by the Query service.
     This API enables you to retrieve statistics about the clusters and nodes running the Query service; view or specify node-level settings; and view or delete requests.
diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc
@@ -5160,14 +5160,49 @@ endif::collapse-models[]
 .icon:bars[fw] Composite Schema
 {blank}
 
-One of the following:
+//tag::Logging_Parameters_Plan[]
 
-* xref:Logging_Parameters_Plan_Pairs[]
+ifdef::model-descriptions[]
+//tag::desc-Logging_Parameters_Plan[]
+An object, or an array of objects, containing one or more field:value pairs to match against the query plan.
+Each pair describes a field in the query plan and the value it must have.
+All completed queries where the specified field:value pairs are found in the plan are logged.
+//end::desc-Logging_Parameters_Plan[]
+endif::model-descriptions[]
 
+[cols="25,55,20",separator=¦]
+|===
+¦ One{nbsp}of{nbsp}... ¦ ¦ Schema
+
+a¦ 
+a¦ 
 
-* xref:Logging_Parameters_Plan_Pairs[]
+[markdown]
+--
+include::index.adoc[tag=desc-Logging_Parameters_Plan_Pairs, opts=optional]
+--
+
+[%hardbreaks]
+{blank}
+a¦ xref:Logging_Parameters_Plan_Pairs[]
+
+
+a¦ _or_
+a¦ 
+
+[markdown]
+--
+An array of objects, each containing one or more field:value pairs.
+--
+
+[%hardbreaks]
+{blank}
+a¦ xref:Logging_Parameters_Plan_Pairs[]
  array
 
+|===
+
+//end::Logging_Parameters_Plan[]
 
 
 // markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-end.adoc[opts=optional]
@@ -5210,7 +5245,7 @@ endif::model-descriptions[]
 ¦ Property ¦ ¦ Schema
 
 a¦ 
-*{lt}field{gt}* +
+*<field>* +
 _additional +
 property_
 a¦ 
diff --git a/docs/modules/n1ql-rest-functions/attachments/_functions.yaml b/docs/modules/n1ql-rest-functions/attachments/_functions.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Query Functions REST API
-  version: capella
+  version: "8.0"
   description: |-
     The Query Functions REST API is a secondary API provided by the Query service.
     This API enables you to manage the JavaScript libraries and objects that are used to create SQL++ user-defined functions.
diff --git a/docs/modules/n1ql-rest-functions/functions.gradle b/docs/modules/n1ql-rest-functions/functions.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/master/docs/spec/functions/functions.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/functions/functions.yaml"
     outputDir = "${rootDir}/docs/modules/n1ql-rest-functions/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "query"
diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc
@@ -1206,7 +1206,7 @@ endif::collapse-models[]
 ¦ Property ¦ ¦ Schema
 
 a¦ 
-*{lt}library{gt}* +
+*<library>* +
 _additional +
 property_
 a¦ 
diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc
@@ -2897,7 +2897,7 @@ a¦ String
 
 
 a¦ [#identifier]
-*{lt}$identifier{gt}* +
+*<$identifier>* +
 _additional +
 property_
 a¦ 
diff --git a/docs/modules/n1ql-rest-query/query-service.gradle b/docs/modules/n1ql-rest-query/query-service.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/master/docs/spec/service/service.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/service/service.yaml"
     outputDir = "${rootDir}/docs/modules/n1ql-rest-query/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "query"
diff --git a/docs/modules/n1ql-rest-settings/attachments/_query-settings.yaml b/docs/modules/n1ql-rest-settings/attachments/_query-settings.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Query Settings REST API
-  version: capella
+  version: "8.0"
   description: |-
     The Query Settings REST API is provided by the Query service.
     This API enables you to view or specify cluster-level Query settings.
diff --git a/docs/modules/n1ql-rest-settings/query-settings.gradle b/docs/modules/n1ql-rest-settings/query-settings.gradle
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/master/docs/spec/settings/settings.yaml"
+    remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/settings/settings.yaml"
     outputDir = "${rootDir}/docs/modules/n1ql-rest-settings/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "query"
diff --git a/docs/preview/HEAD.yml b/docs/preview/HEAD.yml
@@ -1,7 +1,5 @@
 sources:
-  docs-server:
-    branches: release/8.0
-  docs-analytics:
-    branches: release/8.0
+  docs-capella:
+    branches: main
   docs-devex:
-    branches: release/8.0
+    branches: capella
diff --git a/templates/model.mustache b/templates/model.mustache
@@ -30,7 +30,7 @@ a¦ {{>schemas}}
 {{#additionalProperties}}
 {{! ADDITIONAL PROPERTY NAME }}
 a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}
-{{#x-additionalPropertiesName}}*{lt}{{this}}{gt}* +{{/x-additionalPropertiesName}}{{/vendorExtensions}}
+{{#x-additionalPropertiesName}}*<{{this}}>* +{{/x-additionalPropertiesName}}{{/vendorExtensions}}
 _additional +
 property_
 {{! ADDITIONAL PROPERTY DESCRIPTION }}
