```
@Documented
@Retention(SOURCE)
@Target({ANNOTATION_TYPE,METHOD,TYPE})
public @interface ResourceDefinition
```
A composite annotation that specifies the settings for generating the ResourceDefinition section.

Since:

0.1

Author:

nedis

See Also:

Author, BaseEndpoint, Constants, Description, DocumentationDefinition, DocumentationVersion, IncludeDescription, IncludeMode, IntroductionDefinition, License, ResourceGroupDefinition, Title

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`boolean`	`withBodyParametersDescriptionTable`	Returns `true` if the RxMicro framework must generates a description table for HTTP body parameters
`boolean`	`withExamples`	Returns `true` if the RxMicro framework must generates examples of HTTP requests and responses
`boolean`	`withHeadersDescriptionTable`	Returns `true` if the RxMicro framework must generates a description table for HTTP headers
`boolean`	`withInternalErrorResponse`	Returns `true` if the RxMicro framework must generates a documentation for internal error response
`boolean`	`withJsonSchema`	Returns `true` if the RxMicro framework must generates a JSON schema for HTTP requests and responses
`boolean`	`withPathVariablesDescriptionTable`	Returns `true` if the RxMicro framework must generates a description table for path variables
`boolean`	`withQueryParametersDescriptionTable`	Returns `true` if the RxMicro framework must generates a description table for HTTP query parameters
`boolean`	`withReadMore`	Returns `true` if the RxMicro framework must generates read more links to external resources
`boolean`	`withRequestIdResponseHeader`	Returns `true` if the RxMicro framework must generates standard `Request-Id` HTTP header
`boolean`	`withStandardDescriptions`	Returns `true` if the RxMicro framework must generates a standard description for HTTP headers, parameters and path variables
`boolean`	`withValidationResponse`	Returns `true` if the RxMicro framework must generates a documentation for validation response

- Element Detail
  - withExamples
```
boolean withExamples
```
    Returns true if the RxMicro framework must generates examples of HTTP requests and responses
    
    Returns:
    
    true if the RxMicro framework must generates examples of HTTP requests and responses
    
    Default:
    
    true
- - withPathVariablesDescriptionTable
```
boolean withPathVariablesDescriptionTable
```
    Returns true if the RxMicro framework must generates a description table for path variables
    
    Returns:
    
    true if the RxMicro framework must generates a description table for path variables
    
    Default:
    
    true
- - withHeadersDescriptionTable
```
boolean withHeadersDescriptionTable
```
    Returns true if the RxMicro framework must generates a description table for HTTP headers
    
    Returns:
    
    true if the RxMicro framework must generates a description table for HTTP headers
    
    Default:
    
    true
- - withQueryParametersDescriptionTable
```
boolean withQueryParametersDescriptionTable
```
    Returns true if the RxMicro framework must generates a description table for HTTP query parameters
    
    Returns:
    
    true if the RxMicro framework must generates a description table for HTTP query parameters
    
    Default:
    
    true
- - withBodyParametersDescriptionTable
```
boolean withBodyParametersDescriptionTable
```
    Returns true if the RxMicro framework must generates a description table for HTTP body parameters
    
    Returns:
    
    true if the RxMicro framework must generates a description table for HTTP body parameters
    
    Default:
    
    true
- - withJsonSchema
```
boolean withJsonSchema
```
    Returns true if the RxMicro framework must generates a JSON schema for HTTP requests and responses
    
    Returns:
    
    true if the RxMicro framework must generates a JSON schema for HTTP requests and responses
    
    Default:
    
    true
- - withStandardDescriptions
```
boolean withStandardDescriptions
```
    Returns true if the RxMicro framework must generates a standard description for HTTP headers, parameters and path variables
    
    Returns:
    
    true if the RxMicro framework must generates a standard description for HTTP headers, parameters and path variables
    
    Default:
    
    true
- - withReadMore
```
boolean withReadMore
```
    Returns true if the RxMicro framework must generates read more links to external resources
    
    Returns:
    
    true if the RxMicro framework must generates read more links to external resources
    
    Default:
    
    true
- - withValidationResponse
```
boolean withValidationResponse
```
    Returns true if the RxMicro framework must generates a documentation for validation response
    
    Returns:
    
    true if the RxMicro framework must generates a documentation for validation response
    
    Default:
    
    true
- - withInternalErrorResponse
```
boolean withInternalErrorResponse
```
    Returns true if the RxMicro framework must generates a documentation for internal error response
    
    Returns:
    
    true if the RxMicro framework must generates a documentation for internal error response
    
    Default:
    
    true
- - withRequestIdResponseHeader
```
boolean withRequestIdResponseHeader
```
    Returns true if the RxMicro framework must generates standard Request-Id HTTP header
    
    Returns:
    
    true if the RxMicro framework must generates standard Request-Id HTTP header
    
    Default:
    
    true

Annotation Type ResourceDefinition

Optional Element Summary

Element Detail

withExamples

withPathVariablesDescriptionTable

withHeadersDescriptionTable

withQueryParametersDescriptionTable

withBodyParametersDescriptionTable

withJsonSchema

withStandardDescriptions

withReadMore

withValidationResponse

withInternalErrorResponse

withRequestIdResponseHeader