The string fields defined in our OpenAPI definition make use of the following formats.
uuid
Universally Unique Identifier as defined in RFC 4122.
Example: 986b0cc0-e559-47a1-8226-bedf5002371f
986b0cc0-e559-47a1-8226-bedf5002371f
handle
Hyphen-separated lowercase alphanumeric characters.
Example: th1s-1s-a-handle
th1s-1s-a-handle
alias
UTF-8 strings which currently do not have any additional restrictions.
Example: ThĂs 1s an alĂŻas! ăăŁăăă!
ThĂs 1s an alĂŻas! ăăŁăăă!
email
Email address as defined in the HTML5 specification.
Example: this.is.an@email.com
this.is.an@email.com
password
Alphanumeric characters, whitespace and the special characters bellow.
?!,.:;=+-*~<>#$%&@()[]{}/\|_"'`^
Example: th1s 1s a _Pa$$w0rd_!
th1s 1s a _Pa$$w0rd_!
date-time
Timestamp as defined in RFC 3339.
Example: 2023-01-01T00:00:00.000Z
2023-01-01T00:00:00.000Z
duration
Duration as defined in RFC 3339.
Example: PT1M7.25S
PT1M7.25S
byte
Base64-encoded binary data as defined in RFC 4648.
Example: VGhpcyBpcyBub3QgYSByZWFsIGZpbGU=
VGhpcyBpcyBub3QgYSByZWFsIGZpbGU=
jwt
Base64-encoded Json Web Token as defined in RFC 7519.
Example: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyLWEifQ.Enz9YR7aZ9fulmBm9qVP7hA
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyLWEifQ.Enz9YR7aZ9fulmBm9qVP7hA
