Skip to main content

Enhanced Specifications Support

Over the past weeks, we have considerably enhanced our support of the specifications.

minLength, maxLength and pattern

Wherever you need to document restrictions on string fields, OpenAPI and AsyncAPI specifications rely on JSON Schema to support this. minLength and maxLength are meant to constrain the length of a string. pattern restrict the string to a specific Regular Expression (regex).

Email addresses, IBANs and ZIP/Postal codes could be great examples of these features.


readOnly and writeOnly properties

JSON Schema allows defining a property as readOnly or writeOnly. Many examples can easily be imagined when used with AsyncAPI or OpenAPI : readOnly timestamp, writeOnly password, etc...

Our Help Center shares more details on how works with this feature and a few examples.