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

public @Interface License

extends Annotation
Annotations
@Target
@Retention:RUNTIME
@Inherited
Imports
java.lang.annotation.Inherited, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension

License information for the exposed API.
See Also
OpenAPI Specification License Object

Method Summary

Modifier and TypeMethod and Description
public Extension[]

Returns:

array of extensions
extensions
()

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

public String

Returns:

the identifier of the license
identifier
()

The license identifier used for the API.

public String

Returns:

the name of the license
name
()

The license name used for the API.

public String

Returns:

the URL of the license
url
()

A URL to the license used for the API.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

extensionsback to summary
public Extension[] extensions()

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

Returns:Extension[]

array of extensions

Since
3.1
identifierback to summary
public String identifier()

The license identifier used for the API.

Returns:String

the identifier of the license

Since
4.0
nameback to summary
public String name()

The license name used for the API.

Returns:String

the name of the license

urlback to summary
public String url()

A URL to the license used for the API. MUST be in the format of a URL.

Returns:String

the URL of the license