Skip to content

Commit e127807

Browse files
committed
adds information about validationWarn
1 parent d35de42 commit e127807

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Options:
4848
--format -f Whether to output the OpenAPI Description as json or yaml. Default: json
4949
--indent -i File indentation in spaces. Default: 2
5050
--openApiVersion -a OpenAPI version to generate for. Default: 3.0.0
51-
--postmanCollection -p Will generate a postman collection (from the generated OpenAPI Description), in json only, if passed in. Default postman.json
51+
--postmanCollection -p Will generate a postman collection (from the generated OpenAPI Description), in json only, if passed in. Default: postman.json
5252
--validationWarn -w Warn about validation errors only. Will write the OpenAPI file if generation is successful. Default: false
5353
```
5454

@@ -968,6 +968,8 @@ However, you can configure your own rules from the [ruleset available on the Red
968968
}
969969
```
970970

971+
Since rules can be set to "warn", you no longer are required to tell the plugin to ignore errors with the `--validationWarn` flag.
972+
971973
## Example configuration
972974

973975
Please view the example [serverless.yml](test/serverless-tests/best/serverless.yml).

0 commit comments

Comments
 (0)