Skip to content

Latest commit

 

History

History
112 lines (64 loc) · 3.79 KB

definitions.md

File metadata and controls

112 lines (64 loc) · 3.79 KB
Raw

Definitions Schema

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

Definitions Type

object (Definitions)

all of

Definitions Definitions

Definitions group myid

Reference this group by using

{"$ref":"https://example.com/schemas/definitions#/definitions/myid"}
Property Type Required Nullable Defined by
id string Optional cannot be null Definitions
@id string Required cannot be null Definitions
meta:id string Optional cannot be null Definitions

id

A unique identifier given to every addressable thing.

id

  • is optional
  • Type: string
  • cannot be null
  • defined in: Definitions

id Type

string

id Constraints

URI reference: the string must be a URI reference, according to RFC 3986

@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

@id Type

string

@id Constraints

URI: the string must be a URI, according to RFC 3986

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

meta:id Type

string

meta:id Constraints

email: the string must be an email address, according to RFC 5322, section 3.4.1