diff options
| author | Quentin Dufour <quentin@deuxfleurs.fr> | 2022-09-12 16:47:18 +0200 |
|---|---|---|
| committer | Quentin Dufour <quentin@deuxfleurs.fr> | 2022-11-11 09:22:36 +0100 |
| commit | 0a01b34e8119ff9e6c3f922f0434d8c80af20b45 (patch) | |
| tree | 2ea335d8ce2ec387884ff0a18564a4f03f7dcd1f /doc/api/README.md | |
| parent | 66f2daa0259538c64508b37cec89d76a74a71a02 (diff) | |
| download | garage-0a01b34e8119ff9e6c3f922f0434d8c80af20b45.tar.gz garage-0a01b34e8119ff9e6c3f922f0434d8c80af20b45.zip | |
Partial OpenAPI spec for admin API with a viewer
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 +``` |