From 618d46aadb877b307adf97d2ac534a37ed328ba8 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Fri, 6 Jan 2023 22:50:34 +0100 Subject: [PATCH] Add rebuild-doc-api util to regenerate swagger stuff --- ynh-dev | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/ynh-dev b/ynh-dev index dd6a184..21dc80a 100755 --- a/ynh-dev +++ b/ynh-dev @@ -19,11 +19,13 @@ function show_usage() { test [PKG] Deploy, update and run tests for some packages Tests for single modules and functions can ran with e.g. ./ynh-dev test yunohost/appurl:urlavailable - catalog + catalog build Rebuild the custom catalog add Add the custom catalog in Yunohost catalog list override Override default catalog with the custom catalog reset Reset the catalog list to Yunohost's default + + rebuild-api-doc Rebuild the API swagger doc EOF } @@ -49,6 +51,8 @@ function main() catalog|--catalog) catalog $ARGUMENTS ;; + rebuild-api-doc|--rebuild-api-doc) rebuild_api_doc $ARGUMENTS ;; + *) critical "Unknown action ${ACTION}." ;; esac } @@ -526,4 +530,26 @@ function catalog() esac } +function rebuild_api_doc() +{ + test -d yunohost || critical "Expected to find a 'yunohost' folder ?" + + cd yunohost/doc + + if ! test -d swagger + then + # Download swagger ui + info "Downloading swagger UI" + curl -L https://github.com/swagger-api/swagger-ui/archive/refs/tags/v4.15.5.tar.gz | tar -xvz swagger-ui-4.15.5/dist/; + mv swagger-ui-4.15.5/dist/ swagger + rmdir swagger-ui-4.15.5 + fi + + info "Rebuild swagger json/js according to actionsmap" + python3 generate_api_doc.py + success "You should now open yunohost/doc/api.html using your favorite browser" +} + + + main $@