Skip to content

Commit a52b066

Browse files
authored
Merge pull request #154 from JaredCE/README-validator-update
Update README.md
2 parents 6d406f3 + 690f495 commit a52b066

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -942,6 +942,15 @@ This will set the `Cache-Control` Response Header to have a value of "no-store"
942942

943943
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.
944944

945+
I have configured the validator to use these Rules:
946+
947+
* [spec](https://redocly.com/docs/cli/rules/spec/)
948+
* [path-parameters-defined](https://redocly.com/docs/cli/rules/path-parameters-defined/)
949+
* [operation-2xx-response](https://redocly.com/docs/cli/rules/operation-2xx-response/)
950+
* [operation-4xx-response](https://redocly.com/docs/cli/rules/operation-4xx-response/)
951+
* [operation-operationId-unique](https://redocly.com/docs/cli/rules/operation-operationid-unique/)
952+
* [path-declaration-must-exist](https://redocly.com/docs/cli/rules/path-declaration-must-exist/)
953+
945954
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.
946955

947956
## Example configuration

0 commit comments

Comments
 (0)