Skip to content

Commit 18bc94d

Browse files
committed
update datagen docs to reflect that $ref is now supported
1 parent 5513130 commit 18bc94d

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

_docs/schema/datagen/schema-datagen.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ This library is quite powerful. It supports most JSON Schema keywords, includin
3535

3636
It currently does not support:
3737

38-
- anything complex involving RegEx (see below)
39-
- reference keywords (e.g. `$ref`, `$dynamicRef`, etc)
38+
- anything complex involving RegEx\*
39+
- `$dynamicRef`
4040
- annotation / metadata keywords (e.g. `title`, `description`)
4141
- `content*` keywords
4242
- `dependencies` / `dependent*` keywords
@@ -45,6 +45,9 @@ It currently does not support:
4545

4646
Everything else _should_ be mostly supported. Feel free to [open an issue](https://github.com/gregsdennis/json-everything/issues/new/choose) if you find something isn't working as you expect.
4747

48+
> `$ref` support does not check for infinite loops such as occur with schemas like `{ "$ref": "#" }`. If your schema includes a reference like this, a stack overflow exception is likely.
49+
{: .prompt-warning }
50+
4851
### Strings {#schema-datagen-strings}
4952

5053
Without any additional parameters, string generation uses Bogus's Lorem Ipsum generator to create some nice (but oddly readable) garbage text.

0 commit comments

Comments
 (0)