aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index d95c4e4..44770c5 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,8 @@ or run container with LOG_LEVEL ENV
```
docker run -p 8080:8080 -e LOG_LEVEL=INFO onap/org.onap.sdc.sdc-helm-validator:latest
```
+##### API documentation
+Swagger UI is available on endpoint: /docs. OpenAPI.yaml in the main directory contains OpenAPI 3.0.1 definition.
## Available endpoints
* Chart validation:
@@ -83,3 +85,7 @@ Json with the following fields:
Following Json:
[ARRAY OF STRINGS] - supported helm versions
+
+* Swagger UI [GET]
+
+ `http://localhost:[PORT]/docs