Skip to content

Commit 83337ec

Browse files
committed
update README with validation information
1 parent f45c3e5 commit 83337ec

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ Options:
7171
- [CORS](#cors)
7272
- [OWASP Secure Headers](#owasp)
7373

74+
#### Validation
75+
76+
- [Validation](#validator)
77+
7478
### OpenAPI Mapping
7579

7680
| OpenAPI field | Serverless field |
@@ -934,6 +938,12 @@ methodResponse:
934938

935939
This will set the `Cache-Control` Response Header to have a value of "no-store" rather than any value the OWASP Secure Headers Project recommends.
936940

941+
## Validator
942+
943+
Validation for the OpenAPI Description is now (as of 0.0.90) done by [Redocly](https://redocly.com/). This is a slightly less opinionated validator for an OpenAPI Description, it should result in less errors around "YAML Anchors". It's also a maintained library, and has support for OpenAPI 3.1.0 which I hope to be able to support very soon.
944+
945+
I am making use of https://www.npmjs.com/package/@redocly/openapi-core, which I have been warned is likely to change. If you notice anything going wrong with validation of your OpenAPI Description, feel free to open an issue here. I make active use of this library, so will hopefully come across those issues too.
946+
937947
## Example configuration
938948

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

0 commit comments

Comments
 (0)