String type

The string type is used for validating strings/texts containing Unicode characters.

Please note that in order to calculate the length of a string, Opis JSON Schema uses the following libraries/functions, depending which one is available on your system: Opis String (recommended, add it with composer require opis/string), mb_strlen (you must enable mb_string extension for PHP), strlen (will not always return the correct length of a string with Unicode characters).

{
  "type": "string"
}

Validation keywords

The following keywords are supported by the string type, and evaluated in the presented order. All keywords are optional.

minLength

A string is valid against this keyword if its length is greater then, or equal to, the value of this keyword. Value of this keyword must be a non-negative integer.

{
  "type": "string",
  "minLength": 3
}

maxLength

A string is valid against this keyword if its length is lower then, or equal to, the value of this keyword. Value of this keyword must be a non-negative integer.

{
  "type": "string",
  "maxLength": 3
}

pattern

A string is valid against this keyword if it matches the regular expression specified by the value of this keyword. Value of this keyword must be a string representing a valid regular expression.

Please note that the delimiter used by Opis JSON Schema is \x07 (bell) and the modifier is u (PCRE_UTF8).

{
  "type": "string",
  "pattern": "^opis\\/[a-z-]+$"
}

For more information about PHP regular expressions, you can read about

• Pattern Syntax
• preg_match function

contentEncoding

A string is valid against this keyword if it is encoded using the method indicated by the value of this keyword. Value of this keyword must be a string.

Currently, there can only be two values for this keyword

• binary - any string is valid
• base64 - the string must be a valid base64 encoded string

{
  "type": "string",
  "contentEncoding": "base64"
}

contentMediaType

A string is valid against this keyword if its content has the media type (MIME type) indicated by the value of this keyword. If the contentEncoding keyword is also specified, then the decoded content must have the indicated media type. Value of this keyword must be a string.

Out of the box, Opis JSON Schema comes with the following media types

• text/plain - any text
• application/json - json encoded string

If you want to add new media types (MIME types), please read about Media Types.

{
  "type": "string",
  "contentMediaType": "application/json"
}

{
  "type": "string",
  "contentEncoding": "base64",
  "contentMediaType": "application/json"
}