ApiResponse (kosmos-web 0.1.3.8 API)

@Target({METHOD,TYPE,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Inherited
@Repeatable(ApiResponses.class)
public @interface ApiResponse

Required Element Summary

Required Elements
Modifier and Type Required Element Description

ResponseCode responseCode

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`String`	`componentName`
`Content[]`	`content`
`String`	`description`
`Extension[]`	`extensions`
`Header[]`	`headers`
`Link[]`	`links`
`String`	`ref`
`boolean`	`useReturnTypeSchema`

Element Detail
- responseCode
```
ResponseCode responseCode
```

- componentName
```
String componentName
```
  Default:
  
  ""

- description
```
String description
```
  Default:
  
  ""

- headers
```
Header[] headers
```
  Default:
  
  {}

- links
```
Link[] links
```
  Default:
  
  {}

- content
```
Content[] content
```
  Default:
  
  {}

- extensions
```
Extension[] extensions
```
  Default:
  
  {}

- ref
```
String ref
```
  Default:
  
  ""

- useReturnTypeSchema
```
boolean useReturnTypeSchema
```
  Default:
  
  false