@Documented @Target(value={TYPE,METHOD}) @Retention(value=RUNTIME) @Inherited @PropertyStoreApply(value=OpenApiConfigApply.class) public @interface OpenApiConfig
MsgPackSerializer
and MsgPackParser
.
Used primarily for specifying bean configuration properties on REST classes and methods.
Modifier and Type | Optional Element and Description |
---|---|
OpenApi[] |
applyOpenApi
Dynamically applies
@OpenApi annotations to specified classes/methods/fields. |
String |
collectionFormat
Configuration property: Default collection format for HTTP parts.
|
String |
format
Default format for HTTP parts.
|
int |
rank
Optional rank for this config.
|
public abstract int rank
Can be used to override default ordering and application of config annotations.
public abstract OpenApi[] applyOpenApi
@OpenApi
annotations to specified classes/methods/fields.
Provides an alternate approach for applying annotations using @OpenApi.on
to specify the names
to apply the annotation to.
public abstract String format
Specifies the format to use for HTTP parts when not otherwise specified via Schema.format()
.
Possible values:
HttpPartFormat
UON
- UON notation (e.g. INT32
- Signed 32 bits.
INT64
- Signed 64 bits.
FLOAT
- 32-bit floating point number.
DOUBLE
- 64-bit floating point number.
BYTE
- BASE-64 encoded characters.
BINARY
- Hexadecimal encoded octets (e.g. BINARY_SPACED
- Spaced-separated hexadecimal encoded octets (e.g. DATE
- An RFC3339 full-date.
DATE_TIME
- An RFC3339 date-time.
PASSWORD
- Used to hint UIs the input needs to be obscured.
NO_FORMAT
- (default) Not specified.
public abstract String collectionFormat
Specifies the collection format to use for HTTP parts when not otherwise specified via Schema.collectionFormat()
.
Possible values:
HttpPartFormat
CSV
- (default) Comma-separated values (e.g. SSV
- Space-separated values (e.g. TSV
- Tab-separated values (e.g. PIPES
- Pipe-separated values (e.g. MULTI
- Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. UONC
- UON collection notation (e.g. Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.