FAQ

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

    infoDescription


    infoDescription will check a specification to ensure that the info section contains a valid description

    Example ruleset configuration

    info-description:
      description: "Check that the `info` section contains a valid `description`"
      type: "information"
      recommended: true
      severity: "error"
      given: "$"
      then:
        function: "infoDescription"
    

    The function is used by the info-description Rule


    View Function Source