UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

github.com/adobe/jsonschema2md

adobe/jsonschema2md

85 lines (48 loc) • 3.37 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
# Untitled undefined type in Deeply Extending Schema ```txt https://example.com/schemas/deepextending#/allOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ---------------------------------------------------------------------------------------------------- | | Can be instantiated | No | Unknown status | Yes | Forbidden | Allowed | none | [deepextending.schema.json\*](../generated-schemas/deepextending.schema.json "open original schema") | ## 1 Type unknown # undefined Properties | Property | Type | Required | Nullable | Defined by | | :------------------ | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | | [id](#id) | `string` | Optional | cannot be null | [Deeply Extending](deepextending-allof-1-properties-id.md "https://example.com/schemas/deepextending#/allOf/1/properties/id") | | [@id](#@id) | `string` | Required | cannot be null | [Deeply Extending](deepextending-allof-1-properties-id-1.md "https://example.com/schemas/deepextending#/allOf/1/properties/@id") | | [meta:id](#meta:id) | `string` | Optional | cannot be null | [Deeply Extending](deepextending-allof-1-properties-metaid.md "https://example.com/schemas/deepextending#/allOf/1/properties/meta:id") | ## id A unique identifier given to every addressable thing. `id` - is optional - Type: `string` - cannot be null - defined in: [Deeply Extending](deepextending-allof-1-properties-id.md "https://example.com/schemas/deepextending#/allOf/1/properties/id") ### id Type `string` ### id Constraints **URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") ## @id An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` - is required - Type: `string` - cannot be null - defined in: [Deeply Extending](deepextending-allof-1-properties-id-1.md "https://example.com/schemas/deepextending#/allOf/1/properties/@id") ### @id Type `string` ### @id Constraints **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") ## meta:id An about ids. It is meta. If you are confused, send an email to the address specified in this property value. `meta:id` - is optional - Type: `string` - cannot be null - defined in: [Deeply Extending](deepextending-allof-1-properties-metaid.md "https://example.com/schemas/deepextending#/allOf/1/properties/meta:id") ### meta:id Type `string` ### meta:id Constraints **email**: the string must be an email address, according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322 "check the specification")