Skip to content

Commit c75ce35

Browse files
chore: add the link to the API and document how to view it (#121)
Signed-off-by: Harikrishnan Balagopal <[email protected]>
1 parent 83f34e2 commit c75ce35

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99

1010
Move2Kube API provides a REST interface to interact with move2kube [command line tool](https://github.com/konveyor/move2kube).
1111

12+
The API is documented here: https://github.com/konveyor/move2kube-api/blob/main/assets/openapi.json
13+
(Use https://editor.swagger.io/ to view it.)
14+
15+
![API inputs](./assets/images/api-1.png)
16+
![API outputs](./assets/images/api-2.png)
17+
1218
## Usage
1319

1420
Run using container from registry using `make crun`

assets/images/api-1.png

386 KB
Loading

assets/images/api-2.png

411 KB
Loading

0 commit comments

Comments
 (0)