AV-91970: [Documentation] 8.0 Uptake on Capella

.github/workflows/test.yml

@@ -1,8 +1,13 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
 name: Gradle CI
 
 on:
   pull_request:
     branches: [ capella ]
+  merge_group:
+    types: [checks_requested]
 
 jobs:
   test:
@@ -11,6 +16,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.ref }}
     - name: Set up JDK 11
       uses: actions/setup-java@v1
       with:
@@ -19,3 +26,10 @@ jobs:
       run: chmod +x gradlew
     - name: Build with Gradle
       run: ./gradlew --rerun-tasks
+    - name: Push output
+      run: |
+          git config user.name tech-comm-team-couchbase
+          git config user.email tech-comm-team@couchbase.com
+          git add .
+          git commit -m "Build output documentation" || echo "No changes to push"
+          git push

LICENSE

@@ -1,10 +1,11 @@
-Couchbase Developer REST API Documentation © 2024 by Couchbase Inc.
+Couchbase Developer REST API Documentation © 2025 by Couchbase Inc.
 
-Files within the top-level src directory are not currently licensed.
+Within the top-level `docs` directory, files in each `attachments` subdirectory are licensed under the Business Source License 1.1 (BSL).
+For details, see the BSL-Couchbase.txt file in the top-level `licenses` directory.
 
-Files within the top-level docs directory are licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.
-For details, see the CC-BY-NC-SA-4.0.txt file in the top-level licenses directory, or the Creative Commons CC BY-NC-SA 4.0 license page at https://creativecommons.org/licenses/by-nc-sa/4.0/.
+All other files within the top-level `docs` directory are licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.
+For details, see the CC-BY-NC-SA-4.0.txt file in the top-level `licenses` directory, or the Creative Commons CC BY-NC-SA 4.0 license page at https://creativecommons.org/licenses/by-nc-sa/4.0/.
 
 All other files are derivative works, based on the OpenAPI Generator Gradle Plugin.
 These files are licensed under the Apache License, Version 2.0, and have been modified by Couchbase Inc.
-For details, see the APL2.txt file in the top-level licenses directory, or the OpenAPI Generator repository at https://github.com/OpenAPITools/openapi-generator.
+For details, see the APL2.txt file in the top-level `licenses` directory, or the OpenAPI Generator repository at https://github.com/OpenAPITools/openapi-generator.

README.adoc

@@ -5,7 +5,7 @@ This project uses the https://openapi-generator.tech/docs/plugins/#gradle[OpenAP
 == Usage guide
 
 This repository handles several OpenAPI subprojects.
-Each subproject is stored in its own subfolder within the `src` folder.
+Each subproject is stored in its own subfolder within the `docs/modules` folder.
 
 === Build Script
 
@@ -19,12 +19,12 @@ These do not have a gradle build script.
 
 === OpenAPI Specification
 
-Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called `swagger`.
+Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called `attachments`.
 (For some subprojects, the OpenAPI specification file may be stored remotely, i.e. alongside the development source files.)
 
 === AsciiDoc Content
 
-Each generated AsciiDoc page is stored in its own folder in the `docs` folder.
+Within each subproject, the generated AsciiDoc page is stored in the `pages` folder.
 (In Antora terms, each generated AsciiDoc page is stored in its own module.)
 For each subproject, additional AsciiDoc content may be stored in the `partials` folder and its subfolders.
 
@@ -50,7 +50,7 @@ This project is based on the https://openapi-generator.tech/[OpenAPI Generator]
 
 == Licensing
 
-The Couchbase Developer REST API Documentation © 2024 by Couchbase Inc. is licensed under various licenses.
+The Couchbase Developer REST API Documentation © 2025 by Couchbase Inc. is licensed under various licenses.
 The Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) is one such license.
 See the LICENSE file for details.
 All licenses used in this repository can be found in the top-level `licenses` directory.

build.gradle

@@ -26,8 +26,16 @@ wrapper {
 defaultTasks 'admin:openApiGenerate',
              'query-service:openApiGenerate',
              'query-settings:openApiGenerate',
+             'eventing:openApiGenerate',
              'functions:openApiGenerate',
              'indexes:openApiGenerate',
+             'index-settings:openApiGenerate',
+             'search-index:openApiGenerate',
+             'search-nodes:openApiGenerate',
+             'search-advanced:openApiGenerate',
+             'search-stats:openApiGenerate',
+             'search-query:openApiGenerate',
+             'search-manage:openApiGenerate',
              'analytics-admin:openApiGenerate',
              'analytics-config:openApiGenerate',
              'analytics-library:openApiGenerate',

src/analytics-admin/analytics-admin.gradle → docs/modules/analytics-rest-admin/analytics-admin.gradle

@@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    inputSpec = file("swagger/analytics-admin.yaml").getAbsolutePath().toString()
+    inputSpec = file("attachments/_analytics-admin.yaml").getAbsolutePath().toString()
     outputDir = "${rootDir}/docs/modules/analytics-rest-admin/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cb-swagger"
-    gitUserId = "couchbase"
+    gitUserId = "couchbaselabs"
     additionalProperties = [
             specDir: "${rootDir}/docs/modules/analytics-rest-admin/partials/",
             snippetDir: "${rootDir}/docs/modules/analytics-rest-admin/partials/paths/",

src/analytics-admin/swagger/analytics-admin.yaml → 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.
@@ -20,11 +20,11 @@ servers:
           - https
       host:
         default: localhost
-        description: The host name or IP address of a node running the Analytics service.
+        description: The host name or IP address of a node running the Analytics Service.
       port:
         default: "8095"
         description: |-
-          The Analytics service REST port.
+          The Analytics Service REST port.
           Use `18095` for secure access.
         enum:
           - "8095"
@@ -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.