This project uses the OpenAPI Generator Gradle Plugin to convert the OpenAPI specifications for Couchbase Server Developer REST APIs into AsciiDoctor documentation.
This repository handles several OpenAPI subprojects.
Each subproject is stored in its own subfolder within the src folder.
Within each subproject there is a gradle build script with a .gradle extension.
The gradle build script specifies the locations of the OpenAPI source file, any additional AsciiDoc content, and the output AsciiDoc files.
The build.gradle script in the root project folder calls the gradle build scripts from each subproject.
Some subprojects are not currently ready to be built. These do not have a gradle build script.
Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called swagger.
(For some subprojects, the OpenAPI specification file may be stored remotely, i.e. alongside the development source files.)
Each generated AsciiDoc page is stored in its own folder in the docs 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.
./gradlew project:openApiGenerate --rerun-tasks
Where project is the subproject that you want to convert, for example, admin.
This project is based on the OpenAPI Generator project.
The Couchbase Developer REST API Documentation © 2024 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.