v5.0.0

5.0.0 (2020-01-08)

Features

• removes body schema legacy feature file (ae7122b)

BREAKING CHANGES

• Removes JSON Schema Draft 3 support

v4.1.0

4.1.0 (2019-08-02)

Features

• removes "values" from field error messages (3b0cb3e)

v4.0.0

4.0.0 (2019-07-08)

Bug Fixes

• removes "@stable" general tag (411239f)
• uses "I" instead of "you" (47831ab)
• uses inline gavel call in the validation step (1508dfb)

Features

• coordinates composable steps vocabulary (2a6035c)
• introduces unified validation result structure (884f80e)

BREAKING CHANGES

• Gavel validation result structure includes the next changes:

• Validity of an HTTP message and its fields is marked in valid property:

-result.isValid
-result.fields.body.isValid
+result.valid
+result.fields.body.valid

• HTTP message fields may include expected/actual values that represent end compared values:

result.fields.body.values.expected
result.fields.body.values.actual

• Each HTTP message field contains the "kind" enum property of values "text" and "json" representing the end value type:

result.fields.body.kind // "json"

• HTTP message fields no longer include the next properties:
  • validator
  • expectedType
  • `realType*
  • rawData

v3.0.2

3.0.2 (2019-06-20)

Bug Fixes

• tags feature definitions with "@javascript" tag (839669f)

v3.0.1

3.0.1 (2019-06-20)

Bug Fixes

• adds feature deviations for URI validation (b1fa9e1)
• simplifies examples table for URI validation feature (e8d26b9)

v3.0.0

3.0.0 (2019-06-17)

Bug Fixes

• adds proper indentation for "response.feature" (8796e68)
• includes "isValid" key in expected validation result (validators) (6a8ed7c)
• includes relative URI in feature definition (f7ffc14)
• removes duplicate "will (NOT) set errors on "X") criteria (bb81f9d)
• renames "body" to "headers" in validity assertion (headers) (dcda152)
• stores HTTP message fields under "fields" property, not "field" (7823856)
• uses implementation-agnostic phrasing for field validity definition (808ad9e)
• uses non-implementational behavior descriptions for body expectations (2a8475d)
• wraps target property in quotes (da01736)

Features

• adds "method" expectation suite (9c1f450)
• adds "uri" validation feature (cf50d5e)
• adds "uri" validation feature suite (f584714)
• lists HTTP message fields under "field" key (bcd5c9e)
• remove "isValid" from public API (ac26d1d)
• removes "isValidatable" from public API (e84a0cf)
• removes "severity" property from validation errors (2a364e2)
• removes "version" from validation results (d581f81)
• removes async API (8feb224)
• removes references to "HttpRequest" and "HttpResponse" classes (f77a112)
• removing "data_model" feature (8711aa1)
• replaces "results" key with "errors" (9c91c7d)
• sets "isValid" property on each HTTP message field result (c5663f6)
• swaps the order of "real" and "expected" arguments of "validate" (1f2d29f)

BREAKING CHANGES

• Gavel spec no longer has "data_model" feature describing operable HTTP messages.
• Gavel's "validate" method now has the following call signature:
  validate(expected, real)
• Validation errors no longer have "severity" property.
• Validation errors of each individual HTTP message field are now listed in the "errors" key
• Validation result now lists validated HTTP message fields under "field" key
• Removes "isValidatable" from public API

v2.0.0

2.0.0 (2019-05-31)

Features

• removes "isValid" method test suites (6a0f58f)

BREAKING CHANGES

• Gavel public API no longer contains "isValid" method. Use "validate" instead.

v1.3.0

1.3.0 (2019-05-24)

Features

• adds "inValid" property in the validation results (497fee1)

v1.2.3

1.2.3 (2019-05-15)

Bug Fixes

• removes missing array member due to non-working feature (7c324ca)

v1.2.2

1.2.2 (2019-05-15)

Bug Fixes

• provides valid JSON for "body_json_example" feature (c3820be)