Annotation Type Encoding
-
@Target({}) @Retention(RUNTIME) @Inherited public @interface Encoding
The annotation may be used to add encoding details to the definition of a parameter, request or response content, by defining it as fieldContent.encoding()- See Also:
- Encoding (OpenAPI specification),
Content
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleanallowReservedDetermines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 to be included without percent-encoding.StringcontentTypeThe Content-Type for encoding a specific property.booleanexplodeWhen this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.Extension[]extensionsThe list of optional extensionsHeader[]headersAn array of header objectsStringnameThe name of this encoding object instance.StringstyleDescribes how a specific property value will be serialized depending on its type
-
-
-
Element Detail
-
name
String name
The name of this encoding object instance. This property is a key in encoding map of MediaType object and MUST exist in a schema as a property.- Returns:
- name of the encoding
- Default:
- ""
-
-
-
contentType
String contentType
The Content-Type for encoding a specific property.- Returns:
- content type of the encoding
- Default:
- ""
-
-
-
style
String style
Describes how a specific property value will be serialized depending on its type- Returns:
- style of the encoding
- Default:
- ""
-
-
-
headers
Header[] headers
An array of header objects- Returns:
- array of headers
- Default:
- {}
-
-
-
extensions
Extension[] extensions
The list of optional extensions- Returns:
- an optional array of extensions
- Default:
- {}
-
-