FAQ

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

    info-contact


    Formats: Severity:

    JSON Path: $.info

    Contact Information should be pretty self-explanatory (I hope). This rule checks that the contact object has been set on the Information Object

    Why did this violation appear?

    There is no contact object set in the info object. The info object may also be missing.

    What is this rule checking for?

    The info.contact object has been defined.

    Bad example

    info:
      title: Chicken Nuggets Inc. Developer API
      description: This contract has no
    

    Good example

    info:
      title: Chicken Nuggets Inc. Developer API
      description: |
        Want nuggets? Need API driven chicken nugget delivery? We got you covered. Built by nugget fanatics. 
      contact:
        name: Chicken Nuggets Inc.
        url: https://chicken-nugnugs.com
        email: dev-team@chicken-nugnugs.com
    

    How do I fix this violation?

    Ensure the specification includes a Contact Information object under info.contact.

    If you also want to require name, email and url, use the contact-properties rule as well.

    Spectral Equivalent

    The rule is equivalent to contact-properties