FAQ

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

    asyncapi-info-contact-properties


    Formats: Severity:

    asyncapi-info-contact-properties checks that contact details are complete enough to be useful.

    Why did this violation appear?

    The info.contact object is missing name, url, or email.

    Bad example

    asyncapi: 3.1.0
    info:
      title: User events
      version: 1.0.0
      contact:
        name: API Platform
    

    Good example

    asyncapi: 3.1.0
    info:
      title: User events
      version: 1.0.0
      description: Events emitted by the user lifecycle service.
      contact:
        name: API Platform
        url: https://example.com/support
        email: api@example.com
      license:
        name: MIT
        url: https://opensource.org/licenses/MIT
    

    How do I fix this violation?

    Fill in all three contact fields so readers know who owns the contract and how to reach them.