FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • New! Try the OpenAPI DoctorThe OpenAPI Doctor

    Core Functions

    All core/built-in functions. These functions are available to any custom rule. They are generic and can operate against any JSON Path configured.


    falsy

    Checks that a property has not been defined or does not exist.

    oasSchema

    Checks that a specification is a valid OpenAPI schema

    xor

    Checks that one or another property is set, but not both.

    undefined

    Checks an element has NOT been defined.

    length

    Checks the length of a value meets a minimum or maximum length.

    defined

    Checks an element has been defined.

    casing

    Checks value is using the correct case.

    enumeration

    Checks enum values match supplied values.

    pattern

    Check values against regular expressions.

    schema

    Checks that an object matches a supplied JSON Schema.

    alphabetical

    Checks values in an array are alphabetically ordered.

    truthy

    Checks that a property has been defined or exists.