Annotation Type License
-
@Target({}) @Retention(RUNTIME) public @interface License
The annotation may be used inInfo.license()
to define a license for the OpenAPI spec.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Extension[]
extensions
The list of optional extensionsString
identifier
An identifier for a License instance.String
name
The license name used for the API.String
url
A URL to the license used for the API.
-
-
-
Element Detail
-
name
String name
The license name used for the API.- Returns:
- the name of the license
- Default:
- ""
-
-
-
url
String url
A URL to the license used for the API. MUST be in the format of a URL.- Returns:
- URL to the license
- Default:
- ""
-
-
-
extensions
Extension[] extensions
The list of optional extensions- Returns:
- an optional array of extensions
- Default:
- {}
-
-
-
identifier
String identifier
An identifier for a License instance.- Returns:
- the identifier of the license
- Since:
- 2.2.12 / OpenAPI 3.1
- Default:
- ""
-
-