Skip to main content
Version: Next

Constraint

fields object[]
  • Array [
  • pathstring[]required
    Example: ["$.example"]
    idstring
    Example: field-id
    purposestring
    Example: Field purpose
    namestring
    Example: Field name
    filter object
    constobject
    Example: example-const
    enumnumber[]
    Example: [1,"two"]
    exclusiveMinimumobject
    Example: 0
    exclusiveMaximumobject
    Example: 100
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimumobject
    Example: 0
    maximumobject
    Example: 100
    not object
    constobject
    Example: example-const
    enumnumber[]
    Example: [1,"two"]
    exclusiveMinimumobject
    Example: 0
    exclusiveMaximumobject
    Example: 100
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimumobject
    Example: 0
    maximumobject
    Example: 100
    not
    Example: null
    patternstring
    Example: ^[A-Za-z]+$
    contains
    Example: null
    itemsobject
    Example: {"property":{"type":"string","format":"default"}}
    patternstring
    Example: ^[A-Za-z]+$
    contains object
    constobject
    Example: example-const
    enumnumber[]
    Example: [1,"two"]
    exclusiveMinimumobject
    Example: 0
    exclusiveMaximumobject
    Example: 100
    formatstring
    Example: date-time
    minLengthnumber
    Example: 1
    maxLengthnumber
    Example: 255
    minimumobject
    Example: 0
    maximumobject
    Example: 100
    not
    Example: null
    patternstring
    Example: ^[A-Za-z]+$
    contains
    Example: null
    itemsobject
    Example: {"property":{"type":"string","format":"default"}}
    itemsobject
    Example: {"property":{"type":"string","format":"default"}}
    typestringrequired
    Example: string
    optionalboolean
    Example: true
  • ]
  • limit_disclosurestring

    Possible values: [required, preferred]

    Example: preferred
    Constraint
    {
    "fields": [
    {
    "path": [
    "$.example"
    ],
    "id": "example-field",
    "purpose": "Example purpose",
    "name": "Example Name",
    "filter": {
    "type": "string",
    "pattern": "^[A-Za-z]+$"
    },
    "optional": false
    }
    ],
    "limit_disclosure": "preferred"
    }