Annotation Type Info
-
@Target({}) @Retention(RUNTIME) @Inherited public @interface Info
This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.- See Also:
- "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#infoObject"
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Contact
contact
The contact information for the exposed API.java.lang.String
description
A short description of the application.License
license
The license information for the exposed API.java.lang.String
termsOfService
A URL to the Terms of Service for the API.
-
-
-
-
contact
Contact contact
The contact information for the exposed API.- Returns:
- a contact for the application
- Default:
- @org.eclipse.microprofile.openapi.annotations.info.Contact
-
-
-
license
License license
The license information for the exposed API.- Returns:
- the license of the application
- Default:
- @org.eclipse.microprofile.openapi.annotations.info.License(name="")
-
-