Skip to content

chore: trigger release #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 8, 2024
Merged

chore: trigger release #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd2fb53
Merge pull request #10 from restfulhead/release
restfulhead Mar 8, 2024
be8c573
docs: formatting
restfulhead Mar 8, 2024
868ca4c
Merge pull request #11 from restfulhead/release-2
restfulhead Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions packages/azure-functions-openapi-validator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ the request body and response body against a schema.
## Caveats

* Please refer to the [ajv-openapi-request-response-validator README](../ajv-openapi-request-response-validator/README.md) to see what's
supported and what's not. You might also want to take a look at the [test fixtures](../ajv-openapi-request-response-validator/test/fixtures/).
supported and what's not. You might also want to take a look at the
[test fixtures](../ajv-openapi-request-response-validator/test/fixtures/).

## Getting started

Expand Down Expand Up @@ -70,7 +71,8 @@ This library uses the following keys for setting hook data, which can be used by
* `@restfulhead/azure-functions-openapi-validator/request-body-validation-error`: An array of request body validation errors or undefined
* `@restfulhead/azure-functions-openapi-validator/normalized-query-params`: The coerced (if enabled) and normalized query params

For example, if you enabled query parameter coercion (default), then coerced query parameters can be accesse by later hooks and functions like so:
For example, if you enabled query parameter coercion (default), then coerced query parameters can be accesse by later hooks and functions
like so:

```ts
app.hook.preInvocation((preContext: PreInvocationContext) => {
Expand All @@ -88,4 +90,6 @@ app.hook.preInvocation((preContext: PreInvocationContext) => {

The scripts and documentation in this project are released under the [MIT License](LICENSE)

Some of the validation test cases are based on the tests from [openapi-request-validator](`https://github.com/kogosoftwarellc/open-api/tree/main/packages/openapi-request-validator`) by Kogo Software LLC released under MIT.
Some of the validation test cases are based on the tests from
[openapi-request-validator](`https://github.com/kogosoftwarellc/open-api/tree/main/packages/openapi-request-validator`) by Kogo Software LLC
released under MIT.