contact-properties


Formats: Severity:

JSON Path: $.info.contact

Contact Information should be pretty self-explanatory (I hope). Anyone publishing an OpenAPI contract, should include details of who they are, and how to contact them.

Why did this violation appear?

One of more contact details are missing from the contract.

What is this rule checking for?

The following properties are checked to ensure they have been defined.

  • name
  • url
  • email

Bad example

Missing url and email

info:
  contact:
    name: Chicken Nugget Inc.

Missing url

info:
  contact:
    name: Chicken Nugget Inc.
    email: dev-team@chicken-nugnugs.com

How do I fix this violation?

Ensure name, email and url have been defined as part of the specification Contact Information

Spectral Equivalent

The rule is equivalent to contact-properties