fix: request coercer

Author: restfulhead

README.md

@@ -1,85 +1,7 @@
-# Azure Functions Open API v3 specification validation
+# Node.js API tools
 
-This library contains an Open API v3.0 validator and an Azure Functions v4 hook that validates http function requests.
+This mono repository contains libraries for implementing APIs. It contains the following sub-packages:
 
-It identifies the Azure function route and tries to find a matching route in the Open API specification. It then validates query parameters, 
-the request body and response body against the schema.
-
-## Caveats
-
-* Early version: Bugs most likely exist. Bug fixes welcome and more test cases very welcome, too. :-)
-* Only supports v3.0 of the Open API specifications (v3.1 has not been tested, contributions welcome)
-* Only supports content of type `application/json` (and not `multipart/form-data` for example)
-* Does not support external schemas (inline schemas are supported)
-* Does not (yet?) validate headers
-* Does not (really) validate path params, but supports them in the definition and request route
-* Does not support references to properties (e.g. `$ref: '#/components/schemas/Test1/properties/bar/allOf/0/properties/baz'`)
-* Does not support `readOnly` or `writeOnly`.
-* This library does not validate the Open API specification itself. I suggest you use another tool for this for now.
-
-To check out what is supported, take a look at the [test fixtures](/test/fixtures/)
-
-## Getting started
-
-Because the Open API specification can come in different flavors and from different sources, loading the specification file is not in scope
-of this library. To load a YAML based spec, you can for example use `js-yaml` as follows:
-
-```typescript
-const openApiContent = fs.readFileSync('openapi.yaml', 'utf8')
-const openApiSpec = yaml.load(openApiContent)
-```
-
-Once you've loaded the specification, use the `setupValidation` function to register the hook.
-
-```typescript
-setupValidation(openApiSpec)
-```
-
-You can also take a look at [the example function app](example/src/functions/test.ts).
-
-## Configuration
-
-The `setupValidation` function takes in a number of configuration parameters that allow you to modify the behavior of this libary as well as
-[AJV](https://www.npmjs.com/package/ajv), that is used to perform the schema validation.
-
-By default, the hook returns a 400 error response with details about the validation error for request parameter and request body validation.
-Validation errors in the response body are only logged.
-
-Here's an example that disables query parameter validaton completely, logs out request body validation errors (but does not return an error 
-response) and returns a 500 error response for response body validation errors:
-
-```typescript
-setupValidation(openApiSpec, {
-  hook: {
-    queryParameterValidationMode: false,
-    requestBodyValidationMode: {
-      returnErrorResponse: false,
-      logLevel: 'error',
-      strict: true,
-    },
-    responseBodyValidationMode: {
-      returnErrorResponse: true,
-      logLevel: 'warn',
-      strict: true,
-    },
-  }
-})
-```
-
-## Development Setup
-
-To run the example function app locally from VSCode, make sure to install the Azure Functions and Azurite extensions. 
-Then start Azurite via the `Azurite: Start` VSCode task.
-
-Build the library `npm run build` or use `npm run watch` to hotdeploy changes. (Warning: This didn't always work for me in practice.)
-
-Start the function app by running the VScode launch configuration `Debug Functions app`.
-
-Then send some requests to the API, for example: 
-`curl -X POST -H "Content-Type: application/json" -d '{"name":"hi"}' http://localhost:7071/api/users`
-
-## License and Attribution
-
-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.
+* [ajv-openapi-request-response-validator](./packages/ajv-openapi-request-response-validator/README.md): Validation of http request and responses against an OpenAPI schema.
+* [azure-functions-openapi-validator](./packages/azure-functions-openapi-validator/): Azure functions v4 middleware that uses the openapi validator
+* [azure-functions-openapi-validator-example](./packages/azure-functions-openapi-validator-example/README.md): Example Azure functions v4 app that uses the middleware

packages/ajv-openapi-request-response-validator/README.md

@@ -1,4 +1,4 @@
-# Azure Functions Open API v3 specification validation
+# AJV Open API v3 specification validation
 
 This library contains an Open API v3.0 validator that validates http requests and responses.
 
@@ -25,20 +25,25 @@ Because the Open API specification can come in different flavors and from differ
 of this library. To load a YAML based spec, you can for example use `js-yaml` as follows:
 
 ```typescript
+import * as fs from 'fs'
+import * as yaml from 'js-yaml'
+
 const openApiContent = fs.readFileSync('openapi.yaml', 'utf8')
 const openApiSpec = yaml.load(openApiContent)
 ```
 
 Once you've loaded the specification, create an instance of AJV (for example by using the factory) and the validator.
 
 ```typescript
+import { AjvOpenApiValidator, createAjvInstance } from '@restfulhead/ajv-openapi-request-response-validator'
+
 const ajv = createAjvInstance()
 const validator = new AjvOpenApiValidator(spec, ajv)
 ```
 
-You can then use the different validation functions such as `validateQueryParams`, `validateRequestBody` and `validateResponseBody`
+You can then use the different validation functions such as `validateQueryParams`, `validateRequestBody` and `validateResponseBody`.
 
-For examples, see refer to the unit tests.
+For examples, refer to the unit tests.
 
 ## License and Attribution