Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.

Commit 970a647

Browse files
author
Phil Sturgeon
committed
Created a clear TODO for anyone looking
Linked to issues where they exist, and removed CLI usage (as it does not exist).
1 parent 1b8beb2 commit 970a647

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ A flow written in ES6 using Immutable to convert between API description formats
66

77
## What formats are supported and what will be in the future
88
We currently support:
9+
<<<<<<< HEAD
910
- `Swagger v2.0 (in/out)`
1011
- `RAML v1.0 (in/out)`
1112
- `Postman Collection v2.0 (in/out)`
@@ -18,6 +19,21 @@ We intend to support:
1819
- `Postman Dump v1.0`
1920
- `Insomnia v3.0`
2021
- `Api-Blueprint`
22+
=======
23+
- Swagger v2.0 (in/out)
24+
- RAML v1.0 (in/out)
25+
- Postman Collection v2.0 (in/out)
26+
- Paw v3.1 (in/out)
27+
28+
We intend to support:
29+
30+
- Swagger v3.0
31+
- RAML v0.8
32+
- Postman Collection v1.0
33+
- Postman Dump v1.0
34+
- Insomnia v3.0
35+
- API Blueprint
36+
>>>>>>> Created a clear TODO for anyone looking
2137
- and many more.
2238

2339
## Installation
@@ -89,11 +105,6 @@ promise.then((data) => {
89105
})
90106
```
91107

92-
### Using as a CLI (coming soon)
93-
```sh
94-
node ./bin/api-flow.js some_swagger.json -f swagger -t raml > converted.yml
95-
```
96-
97108
### User Interface
98109

99110
API-Flow is one of the main components of [Console.REST](https://github.com/luckymarmot/console-rest). If you're an API user, you can easily use [https://console.rest/](https://console.rest/) to convert API description files. If you're an API provider, you can add a button to your API docs to let your users open and play with your API in client apps including Paw or Postman.

0 commit comments

Comments
 (0)