diff options
| author | Alex <alex@adnab.me> | 2022-11-16 10:51:04 +0000 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2022-11-16 10:51:04 +0000 |
| commit | bcc97724707aaa39fd64490cdd81aa5073285f33 (patch) | |
| tree | 41e0535d0aaf8cfb095576c3c0d41213197dd003 /doc/api/README.md | |
| parent | c4e4cc1156e10fb0a840666873efa1e4dfb7c884 (diff) | |
| parent | cf23aee1831e464b2a445a1ffb302086f32dd6e5 (diff) | |
| download | garage-bcc97724707aaa39fd64490cdd81aa5073285f33.tar.gz garage-bcc97724707aaa39fd64490cdd81aa5073285f33.zip | |
Merge pull request 'OpenAPI spec for admin API' (#379) from ecosystem/openapi into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/379
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md new file mode 100644 index 00000000..d0edb4af --- /dev/null +++ b/doc/api/README.md @@ -0,0 +1,17 @@ +# Browse doc + +Run in this directory: + +``` +python3 -m http.server +``` + +And open in your browser: + - http://localhost:8000/garage-admin-v0.html + +# Validate doc + +``` +wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.1.0/openapi-generator-cli-6.1.0.jar -O openapi-generator-cli.jar +java -jar openapi-generator-cli.jar validate -i garage-admin-v0.yml +``` |