Info

All Superinterfaces:

Constructible, Extensible<Info>
```
public interface Info
extends Constructible, Extensible<Info>
```
This interface represents all the metadata about the API. The metadata may be used by clients if needed, and may be presented in editing or documentation tools.

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#infoObject"

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Info`	`contact(Contact contact)` Sets this Info instance's contact information for the exposed API and returns this instance of Info.
`default Info`	`description(java.lang.String description)` Sets this Info instance's description for the application to the given description and returns this instance of Info.
`Contact`	`getContact()` Returns the contact information for the exposed API from this Info instance.
`java.lang.String`	`getDescription()` Returns a short description for the application for this Info instance.
`License`	`getLicense()` Returns the license information for the exposed API from this Info instance.
`java.lang.String`	`getTermsOfService()` Returns the URL to the Terms of Service for the API for this instance of Info.
`java.lang.String`	`getTitle()` Returns the title for the application for this instance of Info
`java.lang.String`	`getVersion()` Returns the version of the OpenAPI document for this Info instance.
`default Info`	`license(License license)` Sets this Info's license information for the exposed API and returns this instance of Info.
`void`	`setContact(Contact contact)` Sets this Info instance's contact information for the exposed API.
`void`	`setDescription(java.lang.String description)` Sets this Info instance's description for the application to the given description.
`void`	`setLicense(License license)` Sets this Info's license information for the exposed API.
`void`	`setTermsOfService(java.lang.String termsOfService)` Sets this Info instance's URL to the Terms of Service for the API to the given String.
`void`	`setTitle(java.lang.String title)` Sets this Info instance's title for the application to the given title.
`void`	`setVersion(java.lang.String version)` Sets the version of the OpenAPI document for this instance of Info to the given version.
`default Info`	`termsOfService(java.lang.String termsOfService)` Sets this Info instance's URL to the Terms of Service for the API to the given String and returns this instance of Info.
`default Info`	`title(java.lang.String title)` Sets this Info instance's title for the application to the given title and returns this instance of Info
`default Info`	`version(java.lang.String version)` Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions

- Method Detail
  - getTitle
```
java.lang.String getTitle()
```
    Returns the title for the application for this instance of Info
    
    Returns:
    
    the title of the application
  - setTitle
```
void setTitle(java.lang.String title)
```
    Sets this Info instance's title for the application to the given title.
    
    Parameters:
    
    title - the title of the application
  - title
```
default Info title(java.lang.String title)
```
    Sets this Info instance's title for the application to the given title and returns this instance of Info
    
    Parameters:
    
    title - the title of the application
    
    Returns:
    
    this Info instance
  - getDescription
```
java.lang.String getDescription()
```
    Returns a short description for the application for this Info instance.
    
    Returns:
    
    a short description of the application
  - setDescription
```
void setDescription(java.lang.String description)
```
    Sets this Info instance's description for the application to the given description.
    
    Parameters:
    
    description - a short description for the application
  - description
```
default Info description(java.lang.String description)
```
    Sets this Info instance's description for the application to the given description and returns this instance of Info.
    
    Parameters:
    
    description - a short description for the application
    
    Returns:
    
    this Info instance
  - getTermsOfService
```
java.lang.String getTermsOfService()
```
    Returns the URL to the Terms of Service for the API for this instance of Info.
    
    Returns:
    
    a URL to the Terms of Service for the API
  - setTermsOfService
```
void setTermsOfService(java.lang.String termsOfService)
```
    Sets this Info instance's URL to the Terms of Service for the API to the given String. The URL must be in the format of a URL.
    
    Parameters:
    
    termsOfService - the URL to the Terms of Service for the API
  - termsOfService
```
default Info termsOfService(java.lang.String termsOfService)
```
    Sets this Info instance's URL to the Terms of Service for the API to the given String and returns this instance of Info. The URL must be in the format of a URL.
    
    Parameters:
    
    termsOfService - the URL to the Terms of Service for the API
    
    Returns:
    
    this Info instance
  - getContact
```
Contact getContact()
```
    Returns the contact information for the exposed API from this Info instance.
    
    Returns:
    
    the contact information for the exposed API
  - setContact
```
void setContact(Contact contact)
```
    Sets this Info instance's contact information for the exposed API.
    
    Parameters:
    
    contact - the contact information for the exposed API
  - contact
```
default Info contact(Contact contact)
```
    Sets this Info instance's contact information for the exposed API and returns this instance of Info.
    
    Parameters:
    
    contact - the contact information for the exposed API
    
    Returns:
    
    this Info instance
  - getLicense
```
License getLicense()
```
    Returns the license information for the exposed API from this Info instance.
    
    Returns:
    
    the license information for the exposed API
  - setLicense
```
void setLicense(License license)
```
    Sets this Info's license information for the exposed API.
    
    Parameters:
    
    license - the license information for the exposed API
  - license
```
default Info license(License license)
```
    Sets this Info's license information for the exposed API and returns this instance of Info.
    
    Parameters:
    
    license - the license information for the exposed API
    
    Returns:
    
    this Info instance
  - getVersion
```
java.lang.String getVersion()
```
    Returns the version of the OpenAPI document for this Info instance.
    
    Returns:
    
    the version of the OpenAPI document
  - setVersion
```
void setVersion(java.lang.String version)
```
    Sets the version of the OpenAPI document for this instance of Info to the given version.
    
    Parameters:
    
    version - the version of the OpenAPI document
  - version
```
default Info version(java.lang.String version)
```
    Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info
    
    Parameters:
    
    version - the version of the OpenAPI document
    
    Returns:
    
    this Info instance

Interface Info

Method Summary

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

Method Detail

getTitle

setTitle

title

getDescription

setDescription

description

getTermsOfService

setTermsOfService

termsOfService

getContact

setContact

contact

getLicense

setLicense

license

getVersion

setVersion

version