Skip to content

Commit 221cd54

Browse files
committed
MB-67577: Migrate Query REST APIs to dev repo (#175)
* Add preview config * Remove Query specs * Move Query gradle scripts to docs * Move Analytics specs and Gradle scripts to docs * Move Eventing specs and build scripts to docs * Move Index specs and Gradle scripts to docs * Move unpublished specs to docs * Update Gradle scripts for new spec locations * Update license and readmes * Update Git repo ID and user ID for query specs * Update copyright year * Build output documentation
1 parent 2abab31 commit 221cd54

46 files changed

Lines changed: 130 additions & 426 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Couchbase Developer REST API Documentation © 2025 by Couchbase Inc.
22

3-
Files within the top-level `src` directory are licensed under the Business Source License 1.1 (BSL).
3+
Within the top-level `docs` directory, files in each `attachments` subdirectory are licensed under the Business Source License 1.1 (BSL).
44
For details, see the BSL-Couchbase.txt file in the top-level `licenses` directory.
55

6-
Files within the top-level `docs` directory are licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.
6+
All other files within the top-level `docs` directory are licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.
77
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/.
88

99
All other files are derivative works, based on the OpenAPI Generator Gradle Plugin.

README.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This project uses the https://openapi-generator.tech/docs/plugins/#gradle[OpenAP
55
== Usage guide
66

77
This repository handles several OpenAPI subprojects.
8-
Each subproject is stored in its own subfolder within the `src` folder.
8+
Each subproject is stored in its own subfolder within the `docs/modules` folder.
99

1010
=== Build Script
1111

@@ -19,12 +19,12 @@ These do not have a gradle build script.
1919

2020
=== OpenAPI Specification
2121

22-
Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called `swagger`.
22+
Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called `attachments`.
2323
(For some subprojects, the OpenAPI specification file may be stored remotely, i.e. alongside the development source files.)
2424

2525
=== AsciiDoc Content
2626

27-
Each generated AsciiDoc page is stored in its own folder in the `docs` folder.
27+
Within each subproject, the generated AsciiDoc page is stored in the `pages` folder.
2828
(In Antora terms, each generated AsciiDoc page is stored in its own module.)
2929
For each subproject, additional AsciiDoc content may be stored in the `partials` folder and its subfolders.
3030

@@ -50,7 +50,7 @@ This project is based on the https://openapi-generator.tech/[OpenAPI Generator]
5050

5151
== Licensing
5252

53-
The Couchbase Developer REST API Documentation © 2024 by Couchbase Inc. is licensed under various licenses.
53+
The Couchbase Developer REST API Documentation © 2025 by Couchbase Inc. is licensed under various licenses.
5454
The Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) is one such license.
5555
See the LICENSE file for details.
5656
All licenses used in this repository can be found in the top-level `licenses` directory.

src/analytics-admin/analytics-admin.gradle renamed to docs/modules/analytics-rest-admin/analytics-admin.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
22

33
openApiGenerate {
44
generatorName = "asciidoc"
5-
inputSpec = file("swagger/analytics-admin.yaml").getAbsolutePath().toString()
5+
inputSpec = file("attachments/analytics-admin.yaml").getAbsolutePath().toString()
66
outputDir = "${rootDir}/docs/modules/analytics-rest-admin/pages"
77
templateDir = "${rootDir}/templates"
88
gitRepoId = "cb-swagger"

src/analytics-admin/swagger/analytics-admin.yaml renamed to docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml

File renamed without changes.
File renamed without changes.

src/analytics-config/analytics-config.gradle renamed to docs/modules/analytics-rest-config/analytics-config.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
22

33
openApiGenerate {
44
generatorName = "asciidoc"
5-
inputSpec = file("swagger/analytics-config.yaml").getAbsolutePath().toString()
5+
inputSpec = file("attachments/analytics-config.yaml").getAbsolutePath().toString()
66
outputDir = "${rootDir}/docs/modules/analytics-rest-config/pages"
77
templateDir = "${rootDir}/templates"
88
gitRepoId = "cb-swagger"

src/analytics-config/swagger/analytics-config.yaml renamed to docs/modules/analytics-rest-config/attachments/analytics-config.yaml

File renamed without changes.
File renamed without changes.

src/analytics-library/analytics-library.gradle renamed to docs/modules/analytics-rest-library/analytics-library.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'org.openapi.generator'
22

33
openApiGenerate {
44
generatorName = "asciidoc"
5-
inputSpec = file("swagger/analytics-library.yaml").getAbsolutePath().toString()
5+
inputSpec = file("attachments/analytics-library.yaml").getAbsolutePath().toString()
66
outputDir = "${rootDir}/docs/modules/analytics-rest-library/pages"
77
templateDir = "${rootDir}/templates"
88
gitRepoId = "cb-swagger"

src/analytics-library/swagger/analytics-library.yaml renamed to docs/modules/analytics-rest-library/attachments/analytics-library.yaml

File renamed without changes.

0 commit comments

Comments
 (0)