Showing:

Annotations
Diagram
Properties
Constraints
Used By
Source
Definition personType
personal-defs.json.html#personal-defs.json#/definitions/personType/items
Annotations
Title  The 'person' property

Description  Specifies information about a person.
Diagram
Type array
Constraints
Unique Items : true

Array Items
Additional Items true
Used by
Source

 "personType": {
  "type": "array",
  "uniqueItems": true,
  "title": "The 'person' property",
  "description": "Specifies information about a person.",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "description": "Rules for properties defining the items that constitute a 'person'",
    "required": [
      "id",
      "name",
      "email",
      "link"
    ],
    "properties": {
      "id": {"$ref": "#/definitions/idType"},
      "name": {"$ref": "#/definitions/nameType"},
      "email": {
        "type": "string",
        "format": "email",
        "title": "The 'email' schema.",
        "description": "Email address for this person."
      },
      "link": {"$ref": "#/definitions/linkType"}
    }
  }
}


Definition personType/items
personal-defs.json.html#personal-defs.json#/definitions/personType/items/properties/id personal-defs.json.html#personal-defs.json#/definitions/personType/items/properties/name personal-defs.json.html#personal-defs.json#/definitions/personType/items/properties/email personal-defs.json.html#personal-defs.json#/definitions/personType/items/properties/link
Annotations
Description  Rules for properties defining the items that constitute a 'person'
Diagram
Type object
Properties
Name Occurrence
id
name
email
link
required
required
required
required
Additional Properties false
Used by
Schema
personType
Source

 "items": {
  "type": "object",
  "additionalProperties": false,
  "description": "Rules for properties defining the items that constitute a 'person'",
  "required": [
    "id",
    "name",
    "email",
    "link"
  ],
  "properties": {
    "id": {"$ref": "#/definitions/idType"},
    "name": {"$ref": "#/definitions/nameType"},
    "email": {
      "type": "string",
      "format": "email",
      "title": "The 'email' schema.",
      "description": "Email address for this person."
    },
    "link": {"$ref": "#/definitions/linkType"}
  }
}


Definition idType
Annotations
Title  The 'id' property

Description  Specifies a required ID for this person. 
Diagram
Type string
Constraints
Max Length : 20
Examples Big.Boss
Used by
Source

 "idType": {
  "type": "string",
  "maxLength": 20,
  "title": "The 'id' property",
  "description": "Specifies a required ID for this person. ",
  "examples": ["Big.Boss"]
}


Definition id
personal-defs.json.html#personal-defs.json#/definitions/idType
Diagram
Type reference
Refers idType
Used by
Source

 "id": {"$ref": "#/definitions/idType"}


Definition nameType
personal-defs.json.html#personal-defs.json#/definitions/nameType/properties/family personal-defs.json.html#personal-defs.json#/definitions/nameType/properties/given
Annotations
Title  The 'name' property

Description  Specifies the family and given name for the person.
Diagram
Type object
Properties
Name Occurrence
family
given
required
required
Additional Properties false
Used by
Source

 "nameType": {
  "type": "object",
  "additionalProperties": false,
  "title": "The 'name' property",
  "description": "Specifies the family and given name for the person.",
  "required": [
    "family",
    "given"
  ],
  "properties": {
    "family": {"$ref": "#/definitions/nameValueType"},
    "given": {"$ref": "personal-defs.json#/definitions/nameValueType"}
  }
}


Definition nameValueType
Annotations
Title  The 'family' or 'given' property

Description  The first name or last name of the person.
Diagram
Type string
Constraints
Min Length : 1

Max Length : 20
Pattern : ^[a-zA-Z ]*$

Examples John
Used by
Source

 "nameValueType": {
  "type": "string",
  "minLength": 1,
  "maxLength": 20,
  "pattern": "^[a-zA-Z ]*$",
  "title": "The 'family' or 'given' property",
  "description": "The first name or last name of the person.",
  "examples": ["John"]
}


Definition family
personal-defs.json.html#personal-defs.json#/definitions/nameValueType
Diagram
Type reference
Refers nameValueType
Used by
Schema
nameType
Source

 "family": {"$ref": "#/definitions/nameValueType"}


Definition given
personal-defs.json.html#personal-defs.json#/definitions/nameValueType
Diagram
Type reference
Refers nameValueType
Used by
Schema
nameType
Source

 "given": {"$ref": "personal-defs.json#/definitions/nameValueType"}


Definition name
personal-defs.json.html#personal-defs.json#/definitions/nameType
Diagram
Type reference
Refers nameType
Used by
Source

 "name": {"$ref": "#/definitions/nameType"}


Definition email
Annotations
Title  The 'email' schema.

Description  Email address for this person.
Diagram
Type string
Constraints
Format : email
Used by
Source

 "email": {
  "type": "string",
  "format": "email",
  "title": "The 'email' schema.",
  "description": "Email address for this person."
}


Definition linkType
personal-defs.json.html#personal-defs.json#/definitions/linkType/properties/subordinates personal-defs.json.html#personal-defs.json#/definitions/linkType/properties/manager
Annotations
Title  The 'link' property

Description  Specifies who is the manager and who are the subordinates for this person.
Diagram
Type object
Properties
Name Occurrence
subordinates
manager
optional
optional
Additional Properties false
Used by
Source

 "linkType": {
  "type": "object",
  "additionalProperties": false,
  "title": "The 'link' property",
  "description": "Specifies who is the manager and who are the subordinates for this person.",
  "properties": {
    "subordinates": {
      "type": "array",
      "title": "The 'subordinates' propety",
      "description": "Specifies the ids of the subordinates.",
      "items": {}
    },
    "manager": {"$ref": "personal-defs.json#/definitions/idType"}
  }
}


Definition subordinates
personal-defs.json.html#personal-defs.json#/definitions/linkType/properties/subordinates/items
Annotations
Title  The 'subordinates' propety

Description  Specifies the ids of the subordinates.
Diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items true
Used by
Schema
linkType
Source

 "subordinates": {
  "type": "array",
  "title": "The 'subordinates' propety",
  "description": "Specifies the ids of the subordinates.",
  "items": {"$ref": "personal-defs.json#/definitions/idType"}
}


Definition subordinates/items
personal-defs.json.html#personal-defs.json#/definitions/idType
Diagram
Type reference
Refers idType
Used by
Source

 "items": {"$ref": "personal-defs.json#/definitions/idType"}


Definition manager
personal-defs.json.html#personal-defs.json#/definitions/idType
Diagram
Type reference
Refers idType
Used by
Schema
linkType
Source

 "manager": {"$ref": "personal-defs.json#/definitions/idType"}


Definition link
personal-defs.json.html#personal-defs.json#/definitions/linkType
Diagram
Type reference
Refers linkType
Used by
Source