Annotation Type RequestBody

    • 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
      The list of optional extensions
      String ref
      A reference to a RequestBody defined in components RequestBodies.
      boolean required
      Determines if the request body is required in the request.
      boolean useParameterTypeSchema
      Set to true to resolve the request body schema from parameter type
    • Element Detail

      • description

        String description
        A brief description of the request body.
        Returns:
        description of the request body
        Default:
        ""
      • content

        Content[] content
        The content of the request body.
        Returns:
        array of content
        Default:
        {}
      • required

        boolean required
        Determines if the request body is required in the request. Defaults to false.
        Returns:
        boolean
        Default:
        false
      • extensions

        Extension[] extensions
        The list of optional extensions
        Returns:
        an optional array of extensions
        Default:
        {}
      • ref

        String ref
        A reference to a RequestBody defined in components RequestBodies.
        Returns:
        the reference
        Since:
        2.0.3
        Default:
        ""
      • useParameterTypeSchema

        boolean useParameterTypeSchema
        Set to true to resolve the request body schema from parameter type
        Since:
        2.2.15
        Default:
        false