Package org.eclipse.microprofile.openapi.annotations.info

Annotation Type Contact

  • @Target({})
@Retention(RUNTIME)
@Inherited
public @interface Contact
    Contact information for the exposed API.
    See Also:
    "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#contactObject"

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String email
      The email address of the contact person/organization.
      java.lang.String name
      The identifying name of the contact person/organization.
      java.lang.String url
      The URL pointing to the contact information.

    • Element Detail

      • name

        java.lang.String name
        The identifying name of the contact person/organization.
        Returns:
        the name of the contact
        Default:
        ""

      • url

        java.lang.String url
        The URL pointing to the contact information. Must be in the format of a URL.
        Returns:
        the URL of the contact
        Default:
        ""

      • email

        java.lang.String email
        The email address of the contact person/organization. Must be in the format of an email address.
        Returns:
        the email address of the contact
        Default:
        ""