Skip to main content
Version: Next

Field

pathstring[]required
Example: ["$.example"]
idstring
Example: field-id
purposestring
Example: Field purpose
namestring
Example: Field name
filter object
const object
oneOf
string
enum object[]
  • Array [
  • oneOf
    string
  • ]
  • exclusiveMinimum object
    oneOf
    string
    exclusiveMaximum object
    oneOf
    string
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimum object
    oneOf
    string
    maximum object
    oneOf
    string
    not object
    const object
    oneOf
    string
    enum object[]
  • Array [
  • oneOf
    string
  • ]
  • exclusiveMinimum object
    oneOf
    string
    exclusiveMaximum object
    oneOf
    string
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimum object
    oneOf
    string
    maximum object
    oneOf
    string
    not
    Example: null
    patternstring
    Example: ^[A-Za-z]+$
    contains
    Example: null
    requiredstring[]
    Example: ["id"]
    properties object
    property name*circular(Filter)
    allOf []
  • Array [
  • circular(NestedFilter)
  • ]
  • items object
    property name*circular(Filter)
    typestring
    Example: object
    patternstring
    Example: ^[A-Za-z]+$
    contains object
    const object
    oneOf
    string
    enum object[]
  • Array [
  • oneOf
    string
  • ]
  • exclusiveMinimum object
    oneOf
    string
    exclusiveMaximum object
    oneOf
    string
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimum object
    oneOf
    string
    maximum object
    oneOf
    string
    not
    Example: null
    patternstring
    Example: ^[A-Za-z]+$
    contains
    Example: null
    requiredstring[]
    Example: ["id"]
    properties object
    property name*circular(Filter)
    allOf []
  • Array [
  • circular(NestedFilter)
  • ]
  • items object
    property name*circular(Filter)
    typestring
    Example: object
    requiredstring[]
    Example: ["id"]
    properties object
    property name*circular(Filter)
    allOf object[]
  • Array [
  • const object
    oneOf
    string
    enum object[]
  • Array [
  • oneOf
    string
  • ]
  • exclusiveMinimum object
    oneOf
    string
    exclusiveMaximum object
    oneOf
    string
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimum object
    oneOf
    string
    maximum object
    oneOf
    string
    not
    Example: null
    patternstring
    Example: ^[A-Za-z]+$
    contains
    Example: null
    requiredstring[]
    Example: ["id"]
    properties object
    property name*circular(Filter)
    allOf []
  • Array [
  • circular(NestedFilter)
  • ]
  • items object
    property name*circular(Filter)
    typestring
    Example: object
  • ]
  • items object
    property name*circular(Filter)
    typestringrequired
    Example: string
    optionalboolean
    Example: true
    Field
    {
    "path": [
    "$.example"
    ],
    "id": "field-id",
    "purpose": "Field purpose",
    "name": "Field name",
    "filter": {
    "type": "string",
    "pattern": "^[A-Za-z]+$"
    },
    "optional": true
    }