DOC-14157: Public specs for the Service REST APIs (#209)

* Standardize spec file names; pass file name to generator
* Include service-desc in page attributes
* Use ${projectDir} in build scripts
* Fix eventing: source spec should be hidden
* Update gradle builds to use project name
* Build output documentation

Author: simon-dew

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

@@ -2,14 +2,15 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    inputSpec = file("attachments/analytics-admin.yaml").getAbsolutePath().toString()
-    outputDir = "${rootDir}/docs/modules/analytics-rest-admin/pages"
+    inputSpec = file("attachments/${project.name}.yaml").getAbsolutePath().toString()
+    outputDir = "${projectDir}/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cb-swagger"
     gitUserId = "couchbaselabs"
     additionalProperties = [
-            specDir: "${rootDir}/docs/modules/analytics-rest-admin/partials/",
-            snippetDir: "${rootDir}/docs/modules/analytics-rest-admin/partials/paths/",
+            serviceDesc: "${project.name}.yaml",
+            specDir: "${projectDir}/partials/",
+            snippetDir: "${projectDir}/partials/paths/",
             headerAttributes: "true",
             useIntroduction: "true",
             useTableTitles: "true",

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

@@ -4,6 +4,8 @@
 :snippetDir: partial$paths/
 :page-topic-type: reference
 :page-toclevels: 2
+:page-service-desc: _attachments/analytics-admin.yaml
+:page-service-desc-type: application/vnd.oai.openapi+yaml
 include::partial$header-attributes.adoc[opts=optional]
 
 [comment]

docs/modules/analytics-rest-config/analytics-config.gradle

@@ -2,14 +2,15 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    inputSpec = file("attachments/analytics-config.yaml").getAbsolutePath().toString()
-    outputDir = "${rootDir}/docs/modules/analytics-rest-config/pages"
+    inputSpec = file("attachments/${project.name}.yaml").getAbsolutePath().toString()
+    outputDir = "${projectDir}/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cb-swagger"
     gitUserId = "couchbaselabs"
     additionalProperties = [
-            specDir: "${rootDir}/docs/modules/analytics-rest-config/partials/",
-            snippetDir: "${rootDir}/docs/modules/analytics-rest-config/partials/paths/",
+            serviceDesc: "${project.name}.yaml",
+            specDir: "${projectDir}/partials/",
+            snippetDir: "${projectDir}/partials/paths/",
             headerAttributes: "true",
             useIntroduction: "true",
             useTableTitles: "true",

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

@@ -4,6 +4,8 @@
 :snippetDir: partial$paths/
 :page-topic-type: reference
 :page-toclevels: 2
+:page-service-desc: _attachments/analytics-config.yaml
+:page-service-desc-type: application/vnd.oai.openapi+yaml
 include::partial$header-attributes.adoc[opts=optional]
 
 [comment]

docs/modules/analytics-rest-library/analytics-library.gradle

@@ -2,14 +2,15 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    inputSpec = file("attachments/analytics-library.yaml").getAbsolutePath().toString()
-    outputDir = "${rootDir}/docs/modules/analytics-rest-library/pages"
+    inputSpec = file("attachments/${project.name}.yaml").getAbsolutePath().toString()
+    outputDir = "${projectDir}/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cb-swagger"
     gitUserId = "couchbaselabs"
     additionalProperties = [
-            specDir: "${rootDir}/docs/modules/analytics-rest-library/partials/",
-            snippetDir: "${rootDir}/docs/modules/analytics-rest-library/partials/paths/",
+            serviceDesc: "${project.name}.yaml",
+            specDir: "${projectDir}/partials/",
+            snippetDir: "${projectDir}/partials/paths/",
             headerAttributes: "true",
             useIntroduction: "true",
             useTableTitles: "true",

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

@@ -4,6 +4,8 @@
 :snippetDir: partial$paths/
 :page-topic-type: reference
 :page-toclevels: 2
+:page-service-desc: _attachments/analytics-library.yaml
+:page-service-desc-type: application/vnd.oai.openapi+yaml
 include::partial$header-attributes.adoc[opts=optional]
 
 [comment]

docs/modules/analytics-rest-links/analytics-links.gradle

@@ -2,14 +2,15 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    inputSpec = file("attachments/analytics-links.yaml").getAbsolutePath().toString()
-    outputDir = "${rootDir}/docs/modules/analytics-rest-links/pages"
+    inputSpec = file("attachments/${project.name}.yaml").getAbsolutePath().toString()
+    outputDir = "${projectDir}/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cb-swagger"
     gitUserId = "couchbaselabs"
     additionalProperties = [
-            specDir: "${rootDir}/docs/modules/analytics-rest-links/partials/",
-            snippetDir: "${rootDir}/docs/modules/analytics-rest-links/partials/paths/",
+            serviceDesc: "${project.name}.yaml",
+            specDir: "${projectDir}/partials/",
+            snippetDir: "${projectDir}/partials/paths/",
             headerAttributes: "true",
             useIntroduction: "true",
             useTableTitles: "true",

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

@@ -4,6 +4,8 @@
 :snippetDir: partial$paths/
 :page-topic-type: reference
 :page-toclevels: 2
+:page-service-desc: _attachments/analytics-links.yaml
+:page-service-desc-type: application/vnd.oai.openapi+yaml
 include::partial$header-attributes.adoc[opts=optional]
 
 [comment]

docs/modules/analytics-rest-service/analytics-service.gradle

@@ -2,14 +2,15 @@ apply plugin: 'org.openapi.generator'
 
 openApiGenerate {
     generatorName = "asciidoc"
-    inputSpec = file("attachments/analytics-service.yaml").getAbsolutePath().toString()
-    outputDir = "${rootDir}/docs/modules/analytics-rest-service/pages"
+    inputSpec = file("attachments/${project.name}.yaml").getAbsolutePath().toString()
+    outputDir = "${projectDir}/pages"
     templateDir = "${rootDir}/templates"
     gitRepoId = "cb-swagger"
     gitUserId = "couchbaselabs"
     additionalProperties = [
-            specDir: "${rootDir}/docs/modules/analytics-rest-service/partials/",
-            snippetDir: "${rootDir}/docs/modules/analytics-rest-service/partials/paths/",
+            serviceDesc: "${project.name}.yaml",
+            specDir: "${projectDir}/partials/",
+            snippetDir: "${projectDir}/partials/paths/",
             headerAttributes: "true",
             useIntroduction: "true",
             useTableTitles: "true",

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

@@ -4,6 +4,8 @@
 :snippetDir: partial$paths/
 :page-topic-type: reference
 :page-toclevels: 2
+:page-service-desc: _attachments/analytics-service.yaml
+:page-service-desc-type: application/vnd.oai.openapi+yaml
 include::partial$header-attributes.adoc[opts=optional]
 
 [comment]