Package io.openapiparser.model.v31

Class RequestBody

java.lang.Object

io.openapiparser.Properties

io.openapiparser.model.v31.RequestBody

All Implemented Interfaces:

Extensions, Reference

public class RequestBody
extends Properties
implements Reference, Extensions

the Request Body object.

See specification: 4.8.13 Request Body Object

Field Summary

Fields inherited from class io.openapiparser.Properties

bucket, context

Constructor Summary

Constructors

Constructor	Description
RequestBody(Context context, io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,MediaType>	getContent()
@Nullable java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.Object>	getExtensions()	map of all extension properties.
java.lang.String	getRef()	$ref value.
RequestBody	getRefObject()
java.lang.Boolean	getRequired()
@Nullable java.lang.String	getSummary()
boolean	isRef()	check if this is a $ref object.

Methods inherited from class io.openapiparser.Properties

getBooleanOrDefault, getBooleanOrFalse, getBooleanOrNull, getIntegerOrDefault, getIntegerOrNull, getMapObjectsOrEmpty, getMapObjectsOrEmpty, getMapSetStringsOrEmpty, getMapStringsOrEmpty, getNumberOrNull, getObjectOrNull, getObjectOrThrow, getObjectsOrEmpty, getRawValue, getRawValueOf, getRefObject, getRefObjectOrThrow, getStringOrNull, getStringOrThrow, getStringsOrEmpty, getStringsOrNull, getValueOf, hasProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestBody

public RequestBody(Context context,
                   io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Detail

isRef

public boolean isRef()

check if this is a $ref object.

Specified by:

isRef in interface Reference

Returns:

true if $ref else false.

getRef

public java.lang.String getRef()

$ref value. Should be guarded by Reference.isRef(). Throws if Reference.isRef() is false.

Specified by:

getRef in interface Reference

Returns:

ref

getSummary

public @Nullable java.lang.String getSummary()

Specified by:

getSummary in interface Reference

getRefObject

public RequestBody getRefObject()

getDescription

public @Nullable java.lang.String getDescription()

Specified by:

getDescription in interface Reference

getContent

public java.util.Map<java.lang.String,MediaType> getContent()

getRequired

public java.lang.Boolean getRequired()

getExtensions

public java.util.Map<java.lang.String,java.lang.Object> getExtensions()

Description copied from interface: Extensions

map of all extension properties.

Specified by:

getExtensions in interface Extensions

Overrides:

getExtensions in class Properties

Returns:

map of extension properties