Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit 7c67e51

Browse files
chore: adds license link, adjusts gherkin examples wording in README
1 parent d3603f5 commit 7c67e51

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,11 +168,11 @@ The validation `result` against the given JSON Schema will look as follows:
168168
}
169169
```
170170

171-
> Note that JSON schema V5+ are not currently supported. [Follow the support progress](https://github.com/apiaryio/gavel.js/issues/90).
171+
> Note that JSON schema Draft-05+ are not currently supported. [Follow the support progress](https://github.com/apiaryio/gavel.js/issues/90).
172172
173173
## Examples
174174

175-
Take a look at the examples of each field validation described in [Gherkin](https://cucumber.io/docs/gherkin/):
175+
Take a look at the [Gherkin](https://cucumber.io/docs/gherkin/) specification, which describes on examples how validation of each field behaves:
176176

177177
- [`method`](https://github.com/apiaryio/gavel-spec/blob/master/features/javascript/fields/method)
178178
- [`statusCode`](https://github.com/apiaryio/gavel-spec/blob/master/features/javascript/fields/statusCode)
@@ -205,7 +205,7 @@ interface HttpMessage {
205205
```ts
206206
// Field kind describes the type of a field's values
207207
// subjected to the end comparison.
208-
enum FieldKind {
208+
enum ValidationKind {
209209
null // non-comparable data (validation didn't happen)
210210
text // compared as text
211211
json // compared as JSON
@@ -216,7 +216,7 @@ interface ValidationResult {
216216
fields: {
217217
[fieldName: string]: {
218218
valid: boolean // validity of a single field
219-
kind: FieldKind
219+
kind: ValidationKind
220220
values: { // end compared values (coerced, normalized)
221221
actual: any
222222
expected: any
@@ -246,4 +246,4 @@ interface FieldError {
246246

247247
## License
248248

249-
MIT
249+
[MIT](LICENSE)

0 commit comments

Comments
 (0)