io.swagger.v3.oas.annotations.info

Annotation Type License

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

The annotation may be used in Info.license() to define a license for the OpenAPI spec.

See Also:

License (OpenAPI specification), OpenAPIDefinition, Info

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Extension[]	extensions The list of optional extensions
String	name The license name used for the API.
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

Default:

""

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:

""

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}