UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

github.com/adobe/jsonschema2md

adobe/jsonschema2md

81 lines (49 loc) • 3.23 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
# Custom Schema ```txt https://example.com/schemas/custom ``` This is an extensible schema. It has `definitions`, that can be used in other schemas. Additionally, it allows custom properties. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :--------------------- | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------------------ | | Cannot be instantiated | Yes | Unknown status | Unknown identifiability | Allowed | Allowed | none | [custom.schema.json](../generated-schemas/custom.schema.json "open original schema") | ## Custom Type `object` ([Custom](custom.md)) all of - [Untitled undefined type in Custom](custom-allof-0.md "check type definition") - [Untitled undefined type in Custom](custom-allof-1.md "check type definition") - [Untitled undefined type in Custom](custom-allof-2.md "check type definition") # Custom Definitions ## Definitions group first Reference this group by using ```json {"$ref":"https://example.com/schemas/custom#/definitions/first"} ``` | Property | Type | Required | Nullable | Defined by | | :---------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------- | | [foo](#foo) | `string` | Optional | cannot be null | [Custom](custom-definitions-first-properties-foo.md "https://example.com/schemas/custom#/definitions/first/properties/foo") | ### foo A unique identifier given to every addressable thing. `foo` - is optional - Type: `string` - cannot be null - defined in: [Custom](custom-definitions-first-properties-foo.md "https://example.com/schemas/custom#/definitions/first/properties/foo") #### foo Type `string` ## Definitions group second Reference this group by using ```json {"$ref":"https://example.com/schemas/custom#/definitions/second"} ``` | Property | Type | Required | Nullable | Defined by | | :---------- | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------- | | [bar](#bar) | `string` | Optional | cannot be null | [Custom](custom-definitions-second-properties-bar.md "https://example.com/schemas/custom#/definitions/second/properties/bar") | ### bar A unique identifier given to every addressable thing. `bar` - is optional - Type: `string` - cannot be null - defined in: [Custom](custom-definitions-second-properties-bar.md "https://example.com/schemas/custom#/definitions/second/properties/bar") #### bar Type `string`