UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

github.com/adobe/jsonschema2md

adobe/jsonschema2md

43 lines (25 loc) • 2.36 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
# Simple Schema ```txt https://example.com/schemas/simple#/properties/refnestedobj/properties/refobj/properties/foo ``` This is a _very_ simple example of a JSON schema. There is only one property. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ---------------------------------------------------------------------------------------- | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [complex.schema.json\*](../generated-schemas/complex.schema.json "open original schema") | ## foo Type `object` ([Simple](complex-properties-refnestedobj-properties-refobj-properties-simple.md)) # Simple Properties | Property | Type | Required | Nullable | Defined by | | :-------- | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [id](#id) | `string` | Optional | cannot be null | [Complex References](complex-properties-refnestedobj-properties-refobj-properties-simple-properties-id.md "https://example.com/schemas/simple#/properties/refnestedobj/properties/refobj/properties/foo/properties/id") | ## id A unique identifier given to every addressable thing. `id` - is optional - Type: `string` - cannot be null - defined in: [Complex References](complex-properties-refnestedobj-properties-refobj-properties-simple-properties-id.md "https://example.com/schemas/simple#/properties/refnestedobj/properties/refobj/properties/foo/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")