Skip to content

Commit e0b2c53

Browse files
committed
updates documentation for OpenAPI 3.0.4 and to say we only support node 20 and above
1 parent da8cbdd commit e0b2c53

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

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

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

1717
Originally based off of: https://github.com/temando/serverless-openapi-documentation
1818

1919
## Install
2020

21-
This plugin works for Serverless (2.x, 3.x and 4.x) and only supports node.js 14 and up.
21+
This plugin works for Serverless (2.x, 3.x and 4.x) and only supports node.js 20 and up.
2222

2323
To add this plugin to your package.json:
2424

@@ -39,7 +39,7 @@ plugins:
3939

4040
## Adding documentation to serverless
4141

42-
To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.3 -p postman.json`
42+
To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.4 -p postman.json`
4343

4444
Options:
4545

@@ -316,7 +316,7 @@ custom:
316316
in: header
317317
```
318318

319-
It accepts all available Security Schemes and follows the specification: https://spec.openapis.org/oas/v3.0.3#security-scheme-object
319+
It accepts all available Security Schemes and follows the specification: https://spec.openapis.org/oas/v3.0.4#security-scheme-object
320320

321321
#### Security on each operation
322322

@@ -904,7 +904,7 @@ getContent:
904904

905905
You can refer to the `operationId` that you created.
906906

907-
You can read more about [links](https://swagger.io/docs/specification/links/) on the swagger.io site and in the [OpenAPI](https://spec.openapis.org/oas/v3.0.3#link-object) specification. They don't seem widely supported just yet, but perhaps they'll improve your documentation.
907+
You can read more about [links](https://swagger.io/docs/specification/links/) on the swagger.io site and in the [OpenAPI](https://spec.openapis.org/oas/v3.0.4#link-object) specification. They don't seem widely supported just yet, but perhaps they'll improve your documentation.
908908

909909
##### `responseHeaders`
910910

0 commit comments

Comments
 (0)