org.eclipse.microprofile.openapi.annotations.info

Annotation Type License

@Target(value={})
 @Retention(value=RUNTIME)
 @Inherited
public @interface License

License information for the exposed API.

See Also:

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The license name used for the API.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	url A URL to the license used for the API.

Element Detail

name

public abstract String name

The license name used for the API.

Returns:

the name of the license

url

public abstract String url

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

Returns:

the URL of the license

Default:

""