io.swagger.annotations

Annotation Type ExternalDocs

@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface ExternalDocs

Represents an external documentation description.

Since:

1.5.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	url URL for the docs.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value A short description of the target documentation.

Element Detail

url

public abstract String url

URL for the docs.

value

public abstract String value

A short description of the target documentation. GFM syntax can be used for rich text representation.

Default:

""