Last updated

contact

Field NameTypeDescription
namestringThe identifying name of the contact person or organization.
urlstringThe URL pointing to the contact information.
emailstringThe email address of the contact person or organization.

Visuals

contact example

The following example defines a contact object within the info object.

info:
  title: Example
  version: ''
  description: |
    # My API description in Markdown

    This is a sample of an info description.
  contact:
    name: API team
    email: team@redocly.com
    url: https://redocly.com/contact-us/

info contact

Types

const Contact: NodeType = {
  properties: {
    name: { type: 'string' },
    url: { type: 'string' },
    email: { type: 'string' },
  },
};