@adobe/jsonschema2md/examples/docs/definitions.md

Validate and document complex JSON Schemas the easy way.

# Definitions Schema

```txt
https://example.com/schemas/definitions
```

This is an example of using a `definitions` object within a schema.

It is imported using `allOf` and `$ref`.

And the description has line breaks.

So.

Many.

Line.

Bre-

aks.

> Everything is better with a quote.


| Abstract               | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                     |
| :--------------------- | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ---------------------------------------------------------------------------------------------- |
| Cannot be instantiated | Yes        | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [definitions.schema.json](../generated-schemas/definitions.schema.json "open original schema") |

## Definitions Type

`object` ([Definitions](definitions.md))

all of

-   [Untitled undefined type in Definitions](definitions-allof-0.md "check type definition")

# Definitions Definitions

## Definitions group myid

Reference this group by using

```json
{"$ref":"https://example.com/schemas/definitions#/definitions/myid"}
```

| Property            | Type     | Required | Nullable       | Defined by                                                                                                                                    |
| :------------------ | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
| [id](#id)           | `string` | Optional | cannot be null | [Definitions](deepextending-allof-1-properties-id.md "https://example.com/schemas/definitions#/definitions/myid/properties/id")          |
| [@id](#@id)         | `string` | Required | cannot be null | [Definitions](deepextending-allof-1-properties-id-1.md "https://example.com/schemas/definitions#/definitions/myid/properties/@id")       |
| [meta:id](#meta:id) | `string` | Optional | cannot be null | [Definitions](deepextending-allof-1-properties-metaid.md "https://example.com/schemas/definitions#/definitions/myid/properties/meta:id") |

### id

A unique identifier given to every addressable thing.


`id`

-   is optional
-   Type: `string`
-   cannot be null
-   defined in: [Definitions](deepextending-allof-1-properties-id.md "https://example.com/schemas/definitions#/definitions/myid/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: [Definitions](deepextending-allof-1-properties-id-1.md "https://example.com/schemas/definitions#/definitions/myid/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: [Definitions](deepextending-allof-1-properties-metaid.md "https://example.com/schemas/definitions#/definitions/myid/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")