Loading...
Searching...
No Matches
RestSchemaValidator module

# RestSchemaValidator Module Introduction

The RestSchemaValidator module provides an abstract REST schema validation API to Qore.

Primary classes provided by this module:

- AbstractRestSchemaValidator
- NullRestSchemaValidator

# RestSchemaValidator Module Release Notes

## RestSchemaValidator v2.2.1

- assume UTF-8 encoding for JSON and YAML payloads, as otherwise deserialization errors occur

## RestSchemaValidator v2.2

- parse and report path arguments when processing REST requests on the server side (issue 4661)

## RestSchemaValidator v2.1.3

- REST handlers must throw a `DESERIALIZATION-ERROR` when deserialization errors occur, so that a `400 Bad Request` response is returned (issue 4647)
- allow for the client's time zone locale to be set for data serialization / deserialization (issue 4639)

## RestSchemaValidator v2.1.2

- allow a logger to be set in validators (issue 4509)

## RestSchemaValidator v2.1.1

- better fixes to REST URI path handling with schema validation; allow REST validator objects to declare if they manage the URI path in requests or not (issue 4059)

## RestSchemaValidator v2.1

- fixed a bug handling complex `Content-Type` headers in responses (issue 4019)
- fixed a bug where the `Expect` header was not supported and where binary message bodies were read as strings (issue 4035)

## RestSchemaValidator v2.0

- implemented support for the DataProvider API (issue 3545)

## RestSchemaValidator v1.1.2

- fixed `NullRestSchemaValidator` to report serialization errors instead of ignoring them and returning about `200 OK` response (issue 3547)

## RestSchemaValidator v1.1.1

- fixed `NullRestSchemaValidator` not respecting set Content-Type header from RestClass (issue 3427)

## RestSchemaValidator v1.1

- updated the default validator to try all serialization methods if multiple methods are available and one fails (issue 2831)

## RestSchemaValidator v1.0.2

- fixed the null validator to handle binary message bodies; fixed issues with `"text"` serialization with binary message bodies (issue 2816)

## RestSchemaValidator v1.0.1

- updated docs for AbstractRestSchemaValidator::parseRequest() to reflect how validation exceptions should be raised for proper error reporting (issue 2344)
- fixed handling of messages with non-object (i.e. non-hash) bodies (issue 2366)

## RestSchemaValidator v1.0

- initial release of the RestSchemaValidator module