Descriptor (Maven Service Documentation Generator Plugin 1.0.0 API)

All Known Implementing Classes:

AbstractDescriptor, ContactDescriptor, ErrorDescriptor, ExternalDocumentationDescriptor, HeaderDescriptor, InfoDescriptor, LicenseDescriptor, OperationDescriptor, ParameterDescriptor, ResponseDescriptor, ServiceDescriptor, ServicesDescriptor
```
public interface Descriptor
```
Interface for a descriptor with meta-data about services.

Author:

hohwille

See Also:

ServicesDescriptor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HTTP_METHOD_DELETE` HTTP DELETE method.
`static String`	`HTTP_METHOD_GET` HTTP GET method.
`static String`	`HTTP_METHOD_HEAD` HTTP HEAD method.
`static String`	`HTTP_METHOD_OPTIONS` HTTP OPTIONS method.
`static String`	`HTTP_METHOD_PATCH` HTTP PATCH method.
`static String`	`HTTP_METHOD_POST` HTTP POST method.
`static String`	`HTTP_METHOD_PUT` HTTP PUT method.
`static String`	`LOCATION_BODY` HTTP BODY method.
`static String`	`LOCATION_COOKIE` REST parameter location for cookie.
`static String`	`LOCATION_FORM_DATA` REST parameter location for form data.
`static String`	`LOCATION_HEADER` HTTP HEADER method.
`static String`	`LOCATION_PATH` REST parameter location for URL path.
`static String`	`LOCATION_QUERY` HTTP QUERY method.
`static String`	`SCHEME_HTTP` Protocol scheme for HTTP (HypterText Transfer Protocol).
`static String`	`SCHEME_HTTPS` Protocol scheme for HTTPS (HTTP Secured).
`static String`	`SCHEME_WS` Protocol scheme for WS (Web Socket).
`static String`	`SCHEME_WSS` Protocol scheme for WSS (Web Socket Secured).
`static String`	`STATUS_CODE_BAD_REQUEST` HTTP status code for bad request.
`static String`	`STATUS_CODE_CONFLICT` HTTP status code for conflict.
`static String`	`STATUS_CODE_FORBIDDEN` HTTP status code for unauthorized (permission denied).
`static String`	`STATUS_CODE_INTERNAL_SERVER_ERROR` HTTP status code for internal server error.
`static String`	`STATUS_CODE_NO_CONTENT` HTTP status code for success without content.
`static String`	`STATUS_CODE_SUCCESS` HTTP status code for success with content.
`static String`	`STATUS_CODE_UNAUTHORIZED` HTTP status code for unauthorized (authentication required).

- Field Detail
  - HTTP_METHOD_GET
```
static final String HTTP_METHOD_GET
```
    HTTP GET method.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD_PUT
```
static final String HTTP_METHOD_PUT
```
    HTTP PUT method.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD_POST
```
static final String HTTP_METHOD_POST
```
    HTTP POST method.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD_DELETE
```
static final String HTTP_METHOD_DELETE
```
    HTTP DELETE method.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD_OPTIONS
```
static final String HTTP_METHOD_OPTIONS
```
    HTTP OPTIONS method.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD_HEAD
```
static final String HTTP_METHOD_HEAD
```
    HTTP HEAD method.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD_PATCH
```
static final String HTTP_METHOD_PATCH
```
    HTTP PATCH method.
    
    See Also:
    
    Constant Field Values
  - LOCATION_QUERY
```
static final String LOCATION_QUERY
```
    HTTP QUERY method.
    
    See Also:
    
    Constant Field Values
  - LOCATION_BODY
```
static final String LOCATION_BODY
```
    HTTP BODY method.
    
    See Also:
    
    Constant Field Values
  - LOCATION_HEADER
```
static final String LOCATION_HEADER
```
    HTTP HEADER method.
    
    See Also:
    
    Constant Field Values
  - LOCATION_PATH
```
static final String LOCATION_PATH
```
    REST parameter location for URL path.
    
    See Also:
    
    Constant Field Values
  - LOCATION_FORM_DATA
```
static final String LOCATION_FORM_DATA
```
    REST parameter location for form data.
    
    See Also:
    
    Constant Field Values
  - LOCATION_COOKIE
```
static final String LOCATION_COOKIE
```
    REST parameter location for cookie.
    
    See Also:
    
    Constant Field Values
  - SCHEME_HTTP
```
static final String SCHEME_HTTP
```
    Protocol scheme for HTTP (HypterText Transfer Protocol).
    
    See Also:
    
    Constant Field Values
  - SCHEME_HTTPS
```
static final String SCHEME_HTTPS
```
    Protocol scheme for HTTPS (HTTP Secured).
    
    See Also:
    
    Constant Field Values
  - SCHEME_WS
```
static final String SCHEME_WS
```
    Protocol scheme for WS (Web Socket).
    
    See Also:
    
    Constant Field Values
  - SCHEME_WSS
```
static final String SCHEME_WSS
```
    Protocol scheme for WSS (Web Socket Secured).
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_SUCCESS
```
static final String STATUS_CODE_SUCCESS
```
    HTTP status code for success with content.
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_NO_CONTENT
```
static final String STATUS_CODE_NO_CONTENT
```
    HTTP status code for success without content.
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_BAD_REQUEST
```
static final String STATUS_CODE_BAD_REQUEST
```
    HTTP status code for bad request.
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_UNAUTHORIZED
```
static final String STATUS_CODE_UNAUTHORIZED
```
    HTTP status code for unauthorized (authentication required).
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_FORBIDDEN
```
static final String STATUS_CODE_FORBIDDEN
```
    HTTP status code for unauthorized (permission denied).
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_CONFLICT
```
static final String STATUS_CODE_CONFLICT
```
    HTTP status code for conflict.
    
    See Also:
    
    Constant Field Values
  - STATUS_CODE_INTERNAL_SERVER_ERROR
```
static final String STATUS_CODE_INTERNAL_SERVER_ERROR
```
    HTTP status code for internal server error.
    
    See Also:
    
    Constant Field Values

Interface Descriptor

Field Summary

Field Detail

HTTP_METHOD_GET

HTTP_METHOD_PUT

HTTP_METHOD_POST

HTTP_METHOD_DELETE

HTTP_METHOD_OPTIONS

HTTP_METHOD_HEAD

HTTP_METHOD_PATCH

LOCATION_QUERY

LOCATION_BODY

LOCATION_HEADER

LOCATION_PATH

LOCATION_FORM_DATA

LOCATION_COOKIE

SCHEME_HTTP

SCHEME_HTTPS

SCHEME_WS

SCHEME_WSS

STATUS_CODE_SUCCESS

STATUS_CODE_NO_CONTENT

STATUS_CODE_BAD_REQUEST

STATUS_CODE_UNAUTHORIZED

STATUS_CODE_FORBIDDEN

STATUS_CODE_CONFLICT

STATUS_CODE_INTERNAL_SERVER_ERROR