Annotation 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"
-
Required Element Summary
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionThe contact information for the exposed API.A short description of the application.The license information for the exposed API.A URL to the Terms of Service for the API.
-
Element Details
-
-
description
String descriptionA short description of the application. CommonMark syntax can be used for rich text representation.- Returns:
- the application's description
- Default:
- ""
-
termsOfService
String termsOfServiceA URL to the Terms of Service for the API. Must be in the format of a URL.- Returns:
- the application's terms of service
- Default:
- ""
-
contact
Contact contactThe contact information for the exposed API.- Returns:
- a contact for the application
- Default:
- @org.eclipse.microprofile.openapi.annotations.info.Contact
-
license
License licenseThe license information for the exposed API.- Returns:
- the license of the application
- Default:
- @org.eclipse.microprofile.openapi.annotations.info.License(name="")
-