Skip to content
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
merged 2 commits into from
Mar 27, 2023
Merged

Generate REST API docs in build-locally.sh #387

merged 2 commits into from
Mar 27, 2023

Conversation

eamansour
Copy link
Member

@eamansour eamansour commented Mar 24, 2023

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 the downloadDependencies task, removing the need to manually download the tool and set an environment variable to it.

Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
@galasa-team
Copy link

Build successful

@eamansour eamansour requested a review from techcobweb March 27, 2023 08:36
Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
@galasa-team
Copy link

Build successful

@eamansour eamansour merged commit 32d21bb into main Mar 27, 2023
@eamansour eamansour deleted the rest-api-docs branch March 27, 2023 13:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants