Package io.muserver.openapi

Class HeaderObject

java.lang.Object

io.muserver.openapi.HeaderObject

public class HeaderObject
extends java.lang.Object

See Also:

HeaderObjectBuilder

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,MediaTypeObject>	content()
boolean	deprecated()
java.lang.String	description()
java.lang.Object	example()
java.util.Map<java.lang.String,ExampleObject>	examples()
boolean	explode()
boolean	required()
SchemaObject	schema()
java.lang.String	style()
void	writeJson(java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Method Detail

writeJson

public void writeJson(java.io.Writer writer)
               throws java.io.IOException

Throws:

java.io.IOException

description

public java.lang.String description()

Returns:

the value described by HeaderObjectBuilder.withDescription(java.lang.String)

required

public boolean required()

Returns:

the value described by HeaderObjectBuilder.withRequired(java.lang.Boolean)

deprecated

public boolean deprecated()

Returns:

the value described by HeaderObjectBuilder.withDeprecated(java.lang.Boolean)

style

public java.lang.String style()

Returns:

the value described by HeaderObjectBuilder.withStyle(java.lang.String)

explode

public boolean explode()

Returns:

the value described by HeaderObjectBuilder.withExplode(java.lang.Boolean)

schema

public SchemaObject schema()

Returns:

the value described by HeaderObjectBuilder.withSchema(io.muserver.openapi.SchemaObject)

example

public java.lang.Object example()

Returns:

the value described by HeaderObjectBuilder.withExample(java.lang.Object)

examples

public java.util.Map<java.lang.String,ExampleObject> examples()

Returns:

the value described by HeaderObjectBuilder.withExamples(java.util.Map<java.lang.String, io.muserver.openapi.ExampleObject>)

content

public java.util.Map<java.lang.String,MediaTypeObject> content()

Returns:

the value described by HeaderObjectBuilder.withContent(java.util.Map<java.lang.String, io.muserver.openapi.MediaTypeObject>)