Info

Skip navigation links

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Target(value={})
 @Retention(value=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"

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

java.lang.String title
The title of the application.

java.lang.String version
The version of the API definition.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and 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.

- Element Detail
  - title
```
public abstract java.lang.String title
```
    The title of the application.
    
    Returns:
    
    the application's title
- - version
```
public abstract java.lang.String version
```
    The version of the API definition.
    
    Returns:
    
    the application's version
- - description
```
public abstract java.lang.String description
```
    A short description of the application. CommonMark syntax can be used for rich text representation.
    
    Returns:
    
    the application's description
    
    Default:
    
    ""
- - termsOfService
```
public abstract java.lang.String termsOfService
```
    A 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
```
public abstract Contact contact
```
    The contact information for the exposed API.
    
    Returns:
    
    a contact for the application
    
    Default:
    
    @org.eclipse.microprofile.openapi.annotations.info.Contact
- - license
```
public abstract License license
```
    The license information for the exposed API.
    
    Returns:
    
    the license of the application
    
    Default:
    
    @org.eclipse.microprofile.openapi.annotations.info.License(name="")

Skip navigation links

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element