Skip to content

Commit

Permalink
Make note about $ref more prominent
Browse files Browse the repository at this point in the history
Closes #5
  • Loading branch information
Phil Sturgeon committed May 10, 2018
1 parent 035a16f commit d1cd88b
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ The example prints out
}
```

**NOTE**: `$ref`s are not dereferenced. Use a dereferencer such as [json-schema-ref-parser](https://www.npmjs.com/package/json-schema-ref-parser) prior to using this package.

### Options

The function accepts `options` object as the second argument.
Expand Down Expand Up @@ -78,9 +80,6 @@ _† Draft v5 is also known as Draft Wright 00, as the drafts are often named af

To convert the other way, check out [openapi-schema-to-json-schema], which this package was based on.

**NOTE**: `$ref`s are not dereferenced. Use a dereferencer such as [json-schema-ref-parser](https://www.npmjs.com/package/json-schema-ref-parser) prior to using this package.


## Tests

To run the test-suite:
Expand Down

0 comments on commit d1cd88b

Please sign in to comment.