This repository has been archived by the owner on Nov 11, 2024. It is now read-only.
Generate REST API docs in build-locally.sh #387
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For galasa-dev/projectmanagement#1406
Uses the
openapi-generator-cli
tool to generate documentation for Galasa's REST API from the existing openapi.yaml file. We already use this tool in generating the openapi client Go code in the CLI, so we do not need to introduce any additional tools.Places the generated documentation into a new
docs/generated/galasaapi
directory.Adds the
openapi-generator-cli
tool as a dependency in Gradle which is downloaded using thedownloadDependencies
task, removing the need to manually download the tool and set an environment variable to it.