Annotation Type Contact
-
@Target({}) @Retention(RUNTIME) public @interface Contact
The annotation may be used inInfo.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 Description String
email
The email address of the contact person/organization.Extension[]
extensions
The list of optional extensionsString
name
The identifying name of the contact person/organization.String
url
The URL pointing to the contact information.
-
-
-
Element Detail
-
name
String name
The identifying name of the contact person/organization.- Returns:
- the name of the contact
- Default:
- ""
-
-
-
url
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
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
Extension[] extensions
The list of optional extensions- Returns:
- an optional array of extensions
- Default:
- {}
-
-