@Target(value={METHOD,TYPE}) @Retention(value=RUNTIME) @Inherited public @interface ExternalDocumentation
When it is applied to a method the value of the annotation is added to the corresponding OpenAPI operation definition.
When it is applied to a type and one or more of the fields are not empty strings the annotation value is added to the OpenAPI document root. If more than one non-empty annotation is applied to a type in the application or if the externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined.
Modifier and Type | Optional Element and Description |
---|---|
String |
description
A short description of the target documentation.
|
String |
url
The URL for the target documentation.
|
public abstract String description
public abstract String url
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.