Skip to content

Commit 7a71d88

Browse files
authored
Merge pull request #272 from JaredCE/update-README
Update readme
2 parents 4adfd7f + c0e25e5 commit 7a71d88

File tree

3 files changed

+1836
-2
lines changed

3 files changed

+1836
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
</a>
1313
</p>
1414

15-
This will generate an OpenAPI V3 (up to v3.0.4) Document file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) or (as of 0.0.120) [Bruno Collection](https://docs.usebruno.com/) from the OpenAPI file. This currently works for `http` and `httpApi` configurations.
15+
This will generate an OpenAPI V3 (up to v3.1.2) Document file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) or (as of 0.0.120) [Bruno Collection](https://docs.usebruno.com/) from the OpenAPI file. This currently works for `http` and `httpApi` configurations.
1616

17-
If you are using the beta of 0.0.115, it will now try and create [OpenAPI V3.1 (3.1.x)](https://spec.openapis.org/oas/v3.1.0.html) Document for you, should you run the command `serverless openapi generate -o openapi.json -f json -a 3.1.1 -p postman.json`. Please see this [guide on migrating to V3.1](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). Whilst I perosnally use this plugin all the time, please do open and report bugs, and I will do my best to fix them.
17+
As of version 0.1.0, you can now create [OpenAPI V3.1 (3.1.x)](https://spec.openapis.org/oas/v3.1.2.html) Documents, should you run the command `serverless openapi generate -o openapi.json -f json -a 3.1.2 -p postman.json`. Please see this [guide on migrating to V3.1](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). Whilst I perosnally use this plugin all the time, please do open and report bugs, and I will do my best to fix them.
1818

1919
Originally based off of: https://github.com/temando/serverless-openapi-documentation
2020

0 commit comments

Comments
 (0)