io.muserver.openapi

Class HeaderObject

java.lang.Object

io.muserver.openapi.HeaderObject

public class HeaderObject
extends Object

See Also:

HeaderObjectBuilder

Method Summary

Modifier and Type	Method and Description
Map<String,MediaTypeObject>	content()
Boolean	deprecated()
String	description()
Object	example()
Map<String,ExampleObject>	examples()
String	explode()
boolean	required()
SchemaObject	schema()
String	style()
void	writeJson(Writer writer) Writes this object as a JSON Object

Methods inherited from class java.lang.Object

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

Method Detail

writeJson

public void writeJson(Writer writer)
               throws IOException

Writes this object as a JSON Object

Parameters:

writer - The writer to write to

Throws:

IOException - Thrown if the writer throws this while writing

description

public String description()

Returns:

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

required

public boolean required()

Returns:

the value described by HeaderObjectBuilder.withRequired(boolean)

deprecated

public Boolean deprecated()

Returns:

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

style

public String style()

Returns:

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

explode

public String explode()

Returns:

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

schema

public SchemaObject schema()

Returns:

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

example

public Object example()

Returns:

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

examples

public Map<String,ExampleObject> examples()

Returns:

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

content

public Map<String,MediaTypeObject> content()

Returns:

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