@Documented @Retention(value=RUNTIME) public @interface ExternalDocs
Allows referencing an external resource for extended documentation.
Used to populate the auto-generated Swagger documentation and UI for server-side
Modifier and Type | Optional Element and Description |
---|---|
String[] |
description
|
String |
url
|
String[] |
value
Free-form value for the Swagger ExternalDocumentation Object.
|
public abstract String[] description
A short description of the target documentation.
public abstract String url
The URL for the target documentation. Value MUST be in the format of a URL.
public abstract String[] value
This is a Overview > juneau-marshall > JSON Details > Simplified JSON object that makes up the swagger information for this field.
The following are completely equivalent ways of defining the swagger description of documentation:
The reasons why you may want to use this field include:
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.