io.swagger.v3.oas.annotations.info

Annotation Type Contact

@Target(value={})
 @Retention(value=RUNTIME)
public @interface Contact

The annotation may be used in Info.contact() to define a contact for the OpenAPI spec.

See Also:

Contact (OpenAPI specification), OpenAPIDefinition, Info

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	email The email address of the contact person/organization.
Extension[]	extensions The list of optional extensions
String	name The identifying name of the contact person/organization.
String	url The URL pointing to the contact information.

Element Detail

name

public abstract String name

The identifying name of the contact person/organization.

Returns:

the name of the contact

Default:

""

url

public abstract 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

public abstract 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:

""

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}