You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@
12
12
</a>
13
13
</p>
14
14
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.
16
16
17
17
Originally based off of: https://github.com/temando/serverless-openapi-documentation
18
18
19
19
## Install
20
20
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.
22
22
23
23
To add this plugin to your package.json:
24
24
@@ -39,7 +39,7 @@ plugins:
39
39
40
40
## Adding documentation to serverless
41
41
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`
43
43
44
44
Options:
45
45
@@ -316,7 +316,7 @@ custom:
316
316
in: header
317
317
```
318
318
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
320
320
321
321
#### Security on each operation
322
322
@@ -904,7 +904,7 @@ getContent:
904
904
905
905
You can refer to the `operationId` that you created.
906
906
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.
0 commit comments