Package io.swagger.v3.oas.annotations
Annotation Type ExternalDocumentation
-
@Target({METHOD,TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) @Inherited public @interface ExternalDocumentation
The annotation may be used at method level or as field ofOperation
to add a reference to an external resource for extended documentation of an Operation (OpenAPI specification).It may also be used to add external documentation to
Tag
,Header
orSchema
, or as field ofOpenAPIDefinition
.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
description
A short description of the target documentation.Extension[]
extensions
The list of optional extensionsString
url
The URL for the target documentation.
-
-
-
Element Detail
-
description
String description
A short description of the target documentation.- Returns:
- the documentation description
- Default:
- ""
-
-
-
url
String url
The URL for the target documentation. Value must be in the format of a URL.- Returns:
- the documentation URL
- Default:
- ""
-
-
-
extensions
Extension[] extensions
The list of optional extensions- Returns:
- an optional array of extensions
- Default:
- {}
-
-