[ADP-759] OpenAPI: Contact info

Guidance

• MUST provide contact info in the info.contact object.
• MUST specify the team or business unit name in the info.contact.name field for internal APIs (audience <= COMPANY_INTERNAL).
• MUST specify the URL to the documentation location in the info.contact.url field for external APIs (audience >= PARTNER_EXTERNAL).
• SHOULD include an email address in the info.contact.email field for support purposes, especially for external APIs (audience >= PARTNER_EXTERNAL).
• SHOULD provide a clear and concise description of the contact's role or purpose in the info.contact.description field.

Example

openapi: 3.1.0
info:
  title: Sample API
  description: This is a sample API.
  version: 1.0.0
  contact:
    name: API Support Team
    url: https://document.site/support
    email: support@example.com
    description: For any inquiries related to this API

Related ADPs

• ADP-751: New OpenAPI document
• ADP-752: OpenAPI API audience

References

1. OpenAPI Specification
2. ADP-24: Versioning Mechanism