Top Description Methods
org.eclipse.microprofile.openapi.annotations.info

public @Interface Info

extends Annotation
Annotations
@Target
@Retention:RUNTIME
@Inherited
Imports
java.lang.annotation.Inherited, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension
This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
See Also
OpenAPI Specification Info Object

Method Summary

Modifier and TypeMethod and Description
public Contact

Returns:

a contact for the application
contact()

The contact information for the exposed API.

public String

Returns:

the application's description
description()

A short description of the application.

public Extension[]

Returns:

array of extensions
extensions()

List of extensions to be added to the Info model corresponding to the containing annotation.

public License

Returns:

the license of the application
license()

The license information for the exposed API.

public String

Returns:

the summary for the API
summary()

The summary of the API.

public String

Returns:

the application's terms of service
termsOfService()

A URL to the Terms of Service for the API.

public String

Returns:

the application's title
title()

The title of the application.

public String

Returns:

the application's version
version()

The version of the API definition.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

contactback to summary
public Contact contact()

The contact information for the exposed API.

Returns:Contact

a contact for the application

descriptionback to summary
public String description()

A short description of the application. CommonMark syntax can be used for rich text representation.

Returns:String

the application's description

extensionsback to summary
public Extension[] extensions()

List of extensions to be added to the Info model corresponding to the containing annotation.

Returns:Extension[]

array of extensions

Since
3.1
licenseback to summary
public License license()

The license information for the exposed API.

Returns:License

the license of the application

summaryback to summary
public String summary()

The summary of the API.

Returns:String

the summary for the API

Since
4.0
termsOfServiceback to summary
public String termsOfService()

A URL to the Terms of Service for the API. Must be in the format of a URL.

Returns:String

the application's terms of service

titleback to summary
public String title()

The title of the application.

Returns:String

the application's title

versionback to summary
public String version()

The version of the API definition.

Returns:String

the application's version