Documentation for schema

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

properties_Patch.html#/properties/Patch/items

Used by

Schema

Patch

Source


 "Patch": {
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "path"
    ],
    "properties": {
      "op": {
        "type": "string",
        "enum": [
          "add",
          "replace",
          "remove"
        ]
      },
      "path": {
        "type": "string",
        "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
        "example": "/fields/06gnn2b95example10q91512p5/label"
      },
      "value": {"type": "object"}
    }
  }
}

Diagram

Type

object

Properties

Name	Occurrence
op path value	required required optional

Used by

Schema

Patch

Patch/items

Source


 "items": {
  "type": "object",
  "required": [
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "type": "string",
      "enum": [
        "add",
        "replace",
        "remove"
      ]
    },
    "path": {
      "type": "string",
      "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
      "example": "/fields/06gnn2b95example10q91512p5/label"
    },
    "value": {"type": "object"}
  }
}

Diagram

Type

string

Enumeration

Values

add

replace

remove

Used by

Schema

Patch/items

Patch/items/properties/op

Source


 "op": {
  "type": "string",
  "enum": [
    "add",
    "replace",
    "remove"
  ]
}

Annotations

Description  An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute

Diagram

Type

string

Used by

Schema

Patch/items

Patch/items/properties/path

Source


 "path": {
  "type": "string",
  "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
  "example": "/fields/06gnn2b95example10q91512p5/label"
}

Diagram

Type

object

Used by

Schema

Patch/items

Patch/items/properties/value

Source


 "value": {"type": "object"}