Package org.apache.juneau.marshall.oapi

Annotation Interface OpenApiConfig

@Target({TYPE,METHOD}) @Retention(RUNTIME) @Inherited @ContextApply({SerializerApply.class,ParserApply.class}) public @interface OpenApiConfig
Annotation for specifying config properties defined in MsgPackSerializer and MsgPackParser.

Used primarily for specifying bean configuration properties on REST classes and methods.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    collectionFormat
    Default collection format for HTTP parts.
    String
    format
    Default format for HTTP parts.
    int
    rank
    Optional rank for this config.

  • Element Details

    • collectionFormat

      String collectionFormat
      Default collection format for HTTP parts.

      Specifies the collection format to use for HTTP parts when not otherwise specified via Schema.collectionFormat().

      • HttpPartCollectionFormat
        • CSV - (default) Comma-separated values (e.g. "foo,bar").
        • SSV - Space-separated values (e.g. "foo bar").
        • TSV - Tab-separated values (e.g. "foo\tbar").
        • PIPES - Pipe-separated values (e.g. "foo|bar").
        • MULTI - Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. "foo=bar&foo=baz").
        • UONC - UON collection notation (e.g. "@(foo,bar)").
      See Also:
      Returns:
      The annotation value.
      Default:
      ""

    • format

      String format
      Default format for HTTP parts.

      Specifies the format to use for HTTP parts when not otherwise specified via Schema.format().

      • HttpPartFormat
        • UON - UON notation (e.g. "'foo bar'").
        • 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. "00FF").
        • BINARY_SPACED - Spaced-separated hexadecimal encoded octets (e.g. "00 FF").
        • 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.
      See Also:
      Returns:
      The annotation value.
      Default:
      ""

    • rank

      int rank
      Optional rank for this config.

      Can be used to override default ordering and application of config annotations.

      Returns:
      The annotation value.
      Default:
      0