UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

github.com/adobe/jsonschema2md

adobe/jsonschema2md

96 lines (60 loc) • 2.51 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
--- template: reference foo: bar --- # Type Arrays Schema ``` https://example.com/schemas/typearrays ``` This schema test type arrays and nullable types | [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Identifiable | Custom Properties | Additional Properties | Defined In | | -------------------------- | ---------- | ---------------------- | ------------ | ----------------- | --------------------- | ------------------------------------------------ | | Can be instantiated | No | Experimental | No | Forbidden | Permitted | [typearrays.schema.json](typearrays.schema.json) | # Type Arrays Properties | Property | Type | Required | Nullable | Defined by | | ----------------------------------------------- | -------- | ---------- | -------- | ------------------------------------------ | | [null](#null) | `null` | Optional | No | Type Arrays (this schema) | | [string-or-null](#string-or-null) | `string` | Optional | Yes | Type Arrays (this schema) | | [string-or-number](#string-or-number) | multiple | Optional | No | Type Arrays (this schema) | | [string-or-number-null](#string-or-number-null) | multiple | Optional | Yes | Type Arrays (this schema) | | `*` | any | Additional | Yes | this schema _allows_ additional properties | ## null This is just nothing `null` - is optional - type: `null` - defined in this schema ### null Type `null` This property can only have the value `null`. ## string-or-null Nullable string `string-or-null` - is optional - type: `string` - defined in this schema ### string-or-null Type `string`, nullable ## string-or-number Types can be many things `string-or-number` - is optional - type: multiple - defined in this schema ### string-or-number Type Either one of: - `string` - `number` ## string-or-number-null Types can be many things, even nothing at all. `string-or-number-null` - is optional - type: multiple - defined in this schema ### string-or-number-null Type Either one of: - `string` - `number` - or `null` **All** of the following _requirements_ need to be fulfilled. #### Requirement 1 - []() – `#/definitions/id`