UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

github.com/adobe/jsonschema2md

adobe/jsonschema2md

73 lines (45 loc) • 1.31 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
--- template: reference foo: bar --- # Join Types Schema ``` https://example.com/schemas/join ``` This is an example of a JSON schema with only a join type key. Here a 'oneOf'. | [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Identifiable | Custom Properties | Additional Properties | Defined In | | -------------------------- | ---------- | ---------------------- | ------------ | ----------------- | --------------------- | ------------------------------------ | | Can be instantiated | No | Experimental | No | Forbidden | Permitted | [join.schema.json](join.schema.json) | **One** of the following _conditions_ need to be fulfilled. #### Condition 1 `object` with following properties: | Property | Type | Required | | -------- | ------ | -------- | | `foo` | string | Optional | #### foo A simple string. `foo` - is optional - type: `string` ##### foo Type `string` ##### foo Example ```json hello ``` #### Condition 2 `object` with following properties: | Property | Type | Required | | -------- | ------ | -------- | | `bar` | string | Optional | #### bar A simple string. `bar` - is optional - type: `string` ##### bar Type `string` ##### bar Example ```json world ```