Top Description Methods
org.eclipse.microprofile.openapi.annotations.info

public @Interface Contact

extends Annotation
Annotations
@Target
@Retention:RUNTIME
@Inherited
Imports
java.lang.annotation.Inherited, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension

Contact information for the exposed API.
See Also
OpenAPI Specification Contact Object

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the email address of the contact
email
()

The email address of the contact person/organization.

public Extension[]

Returns:

array of extensions
extensions
()

List of extensions to be added to the Contact model corresponding to the containing annotation.

public String

Returns:

the name of the contact
name
()

The identifying name of the contact person/organization.

public String

Returns:

the URL of the contact
url
()

The URL pointing to the contact information.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

emailback to summary
public String email()

The email address of the contact person/organization. Must be in the format of an email address.

Returns:String

the email address of the contact

extensionsback to summary
public Extension[] extensions()

List of extensions to be added to the Contact model corresponding to the containing annotation.

Returns:Extension[]

array of extensions

Since
3.1
nameback to summary
public String name()

The identifying name of the contact person/organization.

Returns:String

the name of the contact

urlback to summary
public String url()

The URL pointing to the contact information. Must be in the format of a URL.

Returns:String

the URL of the contact