FAQ

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

    oasRefSiblings


    oasRefSiblings checks every $ref in the specification to ensure that it only contains approved sibling nodes.

    This should only be applied to OpenAPI 3.1 documents, as every version before that didn’t allow sibling nodes.

    Example ruleset configuration

    no-$ref-sibling:
      description: "Ensure there are no sibling nodes next to $ref properties"
      type: "validation"
      recommended: true
      severity: "error"
      given: "$"
      then:
        function: "oasRefSiblings"
    

    The function is used by

    the oas-no-$ref-siblings Rule


    View Function Source