Package org.eclipse.microprofile.openapi.annotations.parameters

Annotation Interface RequestBody

@Target({PARAMETER,METHOD}) @Retention(RUNTIME) @Inherited public @interface RequestBody
Describes a single request body.
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Content[]
    content
    The content of the request body.
    String
    description
    A brief description of the request body.
    Extension[]
    extensions
    List of extensions to be added to the RequestBody model corresponding to the containing annotation.
    String
    name
    The unique name to identify this request body.
    String
    ref
    Reference value to a RequestBody object.
    boolean
    required
    Determines if the request body is required in the request.

  • Element Details

    • description

      String description
      A brief description of the request body.

      This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

      Returns:
      description of this requestBody instance
      Default:
      ""

    • content

      Content[] content
      The content of the request body. It is a REQUIRED property unless this is only a reference to a request body instance.
      Returns:
      content of this requestBody instance
      Default:
      {}

    • required

      boolean required
      Determines if the request body is required in the request.

      Note that the default value of this property is true, while the default value of the required property in the OpenAPI specification is false, because Jakarta REST resource methods which accept a request body generally require it.

      Returns:
      whether or not this requestBody is required
      Default:
      true

    • name

      String name
      The unique name to identify this request body. Unless this annotation is used on the actual request body parameter, it is required to match the name of that parameter so the appropriate association can be made. When the request body is defined within Components. The name will be used as the key to add this request body to the 'requestBodies' map for reuse.
      Returns:
      this request body's name
      Default:
      ""

    • ref

      String ref
      Reference value to a RequestBody object.

      This property provides a reference to an object defined elsewhere. This property may be used with description() but is mutually exclusive with all other properties. If properties other than description are defined in addition to the ref property then the result is undefined.

      Returns:
      reference to a request body
      Default:
      ""

    • extensions

      Extension[] extensions
      List of extensions to be added to the RequestBody model corresponding to the containing annotation.
      Returns:
      array of extensions
      Since:
      3.1
      Default:
      {}