io.vertx.openapi.contract

Interface RequestBody

All Superinterfaces:

OpenAPIObject

public interface RequestBody
extends OpenAPIObject

This interface represents the most important attributes of an OpenAPI Operation.
Operation V3.1
Operation V3.0

Method Summary

Modifier and Type	Method and Description
Map<String,MediaType>	getContent()
boolean	isRequired()

Methods inherited from interface io.vertx.openapi.contract.OpenAPIObject

getOpenAPIModel

Method Detail

isRequired

boolean isRequired()

Returns:

true if the request body is required in the request, otherwise false.

getContent

Map<String,MediaType> getContent()

Returns:

a map containing descriptions of potential request payloads. The key is a media type or media type range and the value describes it.