diff options
| author |   Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com> | 2021-04-21 15:30:05 +0200 |
|---|---|---|
| committer | Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com> | 2021-04-23 09:17:39 +0200 |
| commit | 85da74a2400f92d26605ce1da5fef2bd8783d654 (patch) | |
| tree | 6dc50e721356c82cf56ea1f2937adf0966fc98f4 /README.md | |
| parent | cd1fa6fcf91b8f233bd911446aad47fbc6ec70f6 (diff) | |
Add Swagger and OpenAPI description
Issue-ID: SDC-3185
Signed-off-by: Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com>
Change-Id: Ib6371ec21ad8331124efd1fd15d2e82364c10e39
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -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 |