UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

github.com/adobe/jsonschema2md

adobe/jsonschema2md

79 lines (44 loc) • 1.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
--- template: reference foo: bar --- # Extensible Schema ``` https://example.com/schemas/extensible ``` This is an extensible schema. It has `definitions`, that can be used in other schemas | Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | |----------|------------|--------|-------------------|-----------------------|------------| | Cannot be instantiated | Yes | Experimental | Forbidden | Permitted | [extensible.schema.json](extensible.schema.json) | # Extensible Definitions | Property | Type | Group | |----------|------|-------| | [bar](#bar) | `string` | `https://example.com/schemas/extensible#/definitions/second` | | [foo](#foo) | `string` | `https://example.com/schemas/extensible#/definitions/first` | ## bar A horse walks into it. `bar` * is optional * type: `string` * defined in this schema ### bar Type `string` ### bar Examples ```json "whoo" ``` ```json "hoo" ``` ## foo A unique identifier given to every addressable thing. `foo` * is optional * type: `string` * defined in this schema ### foo Type `string` ### foo Example ```json "bar" ```