MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.info.Info

Method Summary

Modifier and Type	Method and Description
public default Info	Returns: this Info instance contact(Contact the contact information for the exposed API contact) Sets this Info instance's contact information for the exposed API and returns this instance of Info.
public default Info	Returns: this Info instance description(String a short description for the application description) Sets this Info instance's description for the application to the given description and returns this instance of Info.
public Contact	Returns: the contact information for the exposed API getContact() Returns the contact information for the exposed API from this Info instance.
public String	Returns: a short description of the application getDescription() Returns a short description for the application for this Info instance.
public License	Returns: the license information for the exposed API getLicense() Returns the license information for the exposed API from this Info instance.
public String	Returns: the summary of the exposed API getSummary() Returns the summary of the exposed API from this Info instance.
public String	Returns: a URL to the Terms of Service for the API getTermsOfService() Returns the URL to the Terms of Service for the API for this instance of Info.
public String	Returns: the title of the application getTitle() Returns the title for the application for this instance of Info
public String	Returns: the version of the OpenAPI document getVersion() Returns the version of the OpenAPI document for this Info instance.
public default Info	Returns: this Info instance license(License the license information for the exposed API license) Sets this Info's license information for the exposed API and returns this instance of Info.
public void	setContact(Contact the contact information for the exposed API contact) Sets this Info instance's contact information for the exposed API.
public void	setDescription(String a short description for the application description) Sets this Info instance's description for the application to the given description.
public void	setLicense(License the license information for the exposed API license) Sets this Info's license information for the exposed API.
public void	setSummary(String the summary of the exposed API summary) Sets this Info instance's summary information for the exposed API.
public void	setTermsOfService(String the URL to the Terms of Service for the API termsOfService) Sets this Info instance's URL to the Terms of Service for the API to the given String.
public void	setTitle(String the title of the application title) Sets this Info instance's title for the application to the given title.
public void	setVersion(String the version of the OpenAPI document version) Sets the version of the OpenAPI document for this instance of Info to the given version.
public default Info	Returns: this Info instance summary(String the summary for the exposed API summary) Sets this Info instance's summary of the API to the given summary and returns this instance of Info.
public default Info	Returns: this Info instance termsOfService(String the URL to the Terms of Service for the API 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.
public default Info	Returns: this Info instance title(String the title of the application title) Sets this Info instance's title for the application to the given title and returns this instance of Info
public default Info	Returns: this Info instance version(String the version of the OpenAPI document version) Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions

Method Detail

contact	back to summary
public default Info contact(Contact contact) Sets this Info instance's contact information for the exposed API and returns this instance of Info. Parameters contact:Contact the contact information for the exposed API Returns:Info this Info instance

contact

back to summary

public default Info contact(Contact contact)

Sets this Info instance's contact information for the exposed API and returns this instance of Info.

Parameters

contact:Contact: the contact information for the exposed API

Returns:Info

this Info instance

description	back to summary
public default Info description(String description) Sets this Info instance's description for the application to the given description and returns this instance of Info. Parameters description:String a short description for the application Returns:Info this Info instance

description

back to summary

public default Info description(String description)

Sets this Info instance's description for the application to the given description and returns this instance of Info.

Parameters

description:String: a short description for the application

Returns:Info

this Info instance

getContact	back to summary
public Contact getContact() Returns the contact information for the exposed API from this Info instance. Returns:Contact the contact information for the exposed API

getContact

back to summary

public Contact getContact()

Returns the contact information for the exposed API from this Info instance.

Returns:Contact: the contact information for the exposed API

getDescription	back to summary
public String getDescription() Returns a short description for the application for this Info instance. Returns:String a short description of the application

getDescription

back to summary

public String getDescription()

Returns a short description for the application for this Info instance.

Returns:String: a short description of the application

getLicense	back to summary
public License getLicense() Returns the license information for the exposed API from this Info instance. Returns:License the license information for the exposed API

getLicense

back to summary

public License getLicense()

Returns the license information for the exposed API from this Info instance.

Returns:License: the license information for the exposed API

getSummary	back to summary
public String getSummary() Returns the summary of the exposed API from this Info instance. Returns:String the summary of the exposed API Since 4.0

getSummary

back to summary

public String getSummary()

Returns the summary of the exposed API from this Info instance.

Returns:String: the summary of the exposed API
Since: 4.0

getTermsOfService	back to summary
public String getTermsOfService() Returns the URL to the Terms of Service for the API for this instance of Info. Returns:String a URL to the Terms of Service for the API

getTermsOfService

back to summary

public String getTermsOfService()

Returns the URL to the Terms of Service for the API for this instance of Info.

Returns:String: a URL to the Terms of Service for the API

getTitle	back to summary
public String getTitle() Returns the title for the application for this instance of Info Returns:String the title of the application

getTitle

back to summary

public String getTitle()

Returns the title for the application for this instance of Info

Returns:String: the title of the application

getVersion	back to summary
public String getVersion() Returns the version of the OpenAPI document for this Info instance. Returns:String the version of the OpenAPI document

getVersion

back to summary

public String getVersion()

Returns the version of the OpenAPI document for this Info instance.

Returns:String: the version of the OpenAPI document

license	back to summary
public default Info license(License license) Sets this Info's license information for the exposed API and returns this instance of Info. Parameters license:License the license information for the exposed API Returns:Info this Info instance

license

back to summary

public default Info license(License license)

Sets this Info's license information for the exposed API and returns this instance of Info.

Parameters

license:License: the license information for the exposed API

Returns:Info

this Info instance

setContact	back to summary
public void setContact(Contact contact) Sets this Info instance's contact information for the exposed API. Parameters contact:Contact the contact information for the exposed API

setContact

back to summary

public void setContact(Contact contact)

Sets this Info instance's contact information for the exposed API.

Parameters

contact:Contact: the contact information for the exposed API

setDescription	back to summary
public void setDescription(String description) Sets this Info instance's description for the application to the given description. Parameters description:String a short description for the application

setDescription

back to summary

public void setDescription(String description)

Sets this Info instance's description for the application to the given description.

Parameters

description:String: a short description for the application

setLicense	back to summary
public void setLicense(License license) Sets this Info's license information for the exposed API. Parameters license:License the license information for the exposed API

setLicense

back to summary

public void setLicense(License license)

Sets this Info's license information for the exposed API.

Parameters

license:License: the license information for the exposed API

setSummary	back to summary
public void setSummary(String summary) Sets this Info instance's summary information for the exposed API. Parameters summary:String the summary of the exposed API Since 4.0

setSummary

back to summary

public void setSummary(String summary)

Sets this Info instance's summary information for the exposed API.

Parameters

summary:String: the summary of the exposed API

Since

4.0

setTermsOfService	back to summary
public void setTermsOfService(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:String the URL to the Terms of Service for the API

setTermsOfService

back to summary

public void setTermsOfService(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:String: the URL to the Terms of Service for the API

setTitle	back to summary
public void setTitle(String title) Sets this Info instance's title for the application to the given title. Parameters title:String the title of the application

setTitle

back to summary

public void setTitle(String title)

Sets this Info instance's title for the application to the given title.

Parameters

title:String: the title of the application

setVersion	back to summary
public void setVersion(String version) Sets the version of the OpenAPI document for this instance of Info to the given version. Parameters version:String the version of the OpenAPI document

setVersion

back to summary

public void setVersion(String version)

Sets the version of the OpenAPI document for this instance of Info to the given version.

Parameters

version:String: the version of the OpenAPI document

summary	back to summary
public default Info summary(String summary) Sets this Info instance's summary of the API to the given summary and returns this instance of Info. Parameters summary:String the summary for the exposed API Returns:Info this Info instance Since 4.0

summary

back to summary

public default Info summary(String summary)

Sets this Info instance's summary of the API to the given summary and returns this instance of Info.

Parameters

summary:String: the summary for the exposed API

Returns:Info

this Info instance

Since

4.0

termsOfService	back to summary
public default Info termsOfService(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:String the URL to the Terms of Service for the API Returns:Info this Info instance

termsOfService

back to summary

public default Info termsOfService(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:String: the URL to the Terms of Service for the API

Returns:Info

this Info instance

title	back to summary
public default Info title(String title) Sets this Info instance's title for the application to the given title and returns this instance of Info Parameters title:String the title of the application Returns:Info this Info instance

title

back to summary

public default Info title(String title)

Sets this Info instance's title for the application to the given title and returns this instance of Info

Parameters

title:String: the title of the application

Returns:Info

this Info instance

version	back to summary
public default Info version(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:String the version of the OpenAPI document Returns:Info this Info instance

version

back to summary

public default Info version(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:String: the version of the OpenAPI document

Returns:Info

this Info instance

public Interface Info

Method Summary

Method Detail