Package io.apicurio.datamodels.models.openapi.v31

Interface OpenApi31Header

All Superinterfaces:

Extensible, Node, OpenApi31ExamplesParent, OpenApi31Extensible, OpenApi31Referenceable, OpenApiExamplesParent, OpenApiExtensible, OpenApiHeader, OpenApiReferenceable, Referenceable, Visitable

All Known Implementing Classes:

OpenApi31HeaderImpl

public interface OpenApi31Header
extends OpenApiHeader, OpenApi31Extensible, OpenApi31Referenceable, OpenApi31ExamplesParent

Method Summary

Modifier and Type	Method	Description
void	addContent(String name, OpenApi31MediaType value)
void	addExample(String name, OpenApiExample value)
void	addExtension(String name, com.fasterxml.jackson.databind.JsonNode value)
void	clearContent()
void	clearExamples()
void	clearExtensions()
OpenApi31Example	createExample()
OpenApi31MediaType	createMediaType()
OpenApi31Schema	createSchema()
String	get$ref()
Map<String,OpenApi31MediaType>	getContent()
String	getDescription()
com.fasterxml.jackson.databind.JsonNode	getExample()
Map<String,OpenApiExample>	getExamples()
Map<String,com.fasterxml.jackson.databind.JsonNode>	getExtensions()
OpenApi31Schema	getSchema()
String	getStyle()
String	getSummary()
void	insertContent(String name, OpenApi31MediaType value, int atIndex)
void	insertExample(String name, OpenApiExample value, int atIndex)
void	insertExtension(String name, com.fasterxml.jackson.databind.JsonNode value, int atIndex)
Boolean	isAllowEmptyValue()
Boolean	isAllowReserved()
Boolean	isDeprecated()
Boolean	isExplode()
Boolean	isRequired()
void	removeContent(String name)
void	removeExample(String name)
void	removeExtension(String name)
void	set$ref(String value)
void	setAllowEmptyValue(Boolean value)
void	setAllowReserved(Boolean value)
void	setDeprecated(Boolean value)
void	setDescription(String value)
void	setExample(com.fasterxml.jackson.databind.JsonNode value)
void	setExplode(Boolean value)
void	setRequired(Boolean value)
void	setSchema(OpenApi31Schema value)
void	setStyle(String value)
void	setSummary(String value)

Methods inherited from interface io.apicurio.datamodels.models.Node

addExtraProperty, attach, clearNodeAttributes, emptyClone, getExtraProperty, getExtraPropertyNames, getNodeAttribute, getNodeAttributeNames, hasExtraProperties, isAttached, mapPropertyName, modelId, parent, parentPropertyName, parentPropertyType, removeExtraProperty, root, setNodeAttribute

Methods inherited from interface io.apicurio.datamodels.models.Visitable

accept

Method Detail

isRequired

Boolean isRequired()

setRequired

void setRequired(Boolean value)

isDeprecated

Boolean isDeprecated()

setDeprecated

void setDeprecated(Boolean value)

isAllowEmptyValue

Boolean isAllowEmptyValue()

setAllowEmptyValue

void setAllowEmptyValue(Boolean value)

getStyle

String getStyle()

setStyle

void setStyle(String value)

isExplode

Boolean isExplode()

setExplode

void setExplode(Boolean value)

isAllowReserved

Boolean isAllowReserved()

setAllowReserved

void setAllowReserved(Boolean value)

getSchema

OpenApi31Schema getSchema()

setSchema

void setSchema(OpenApi31Schema value)

createSchema

OpenApi31Schema createSchema()

getExample

com.fasterxml.jackson.databind.JsonNode getExample()

setExample

void setExample(com.fasterxml.jackson.databind.JsonNode value)

createMediaType

OpenApi31MediaType createMediaType()

getContent

Map<String,OpenApi31MediaType> getContent()

addContent

void addContent(String name,
                OpenApi31MediaType value)

clearContent

void clearContent()

removeContent

void removeContent(String name)

insertContent

void insertContent(String name,
                   OpenApi31MediaType value,
                   int atIndex)

get$ref

String get$ref()

Specified by:

get$ref in interface Referenceable

set$ref

void set$ref(String value)

Specified by:

set$ref in interface Referenceable

getSummary

String getSummary()

Specified by:

getSummary in interface OpenApi31Referenceable

setSummary

void setSummary(String value)

Specified by:

setSummary in interface OpenApi31Referenceable

getDescription

String getDescription()

Specified by:

getDescription in interface OpenApi31Referenceable

Specified by:

getDescription in interface OpenApiHeader

setDescription

void setDescription(String value)

Specified by:

setDescription in interface OpenApi31Referenceable

Specified by:

setDescription in interface OpenApiHeader

createExample

OpenApi31Example createExample()

Specified by:

createExample in interface OpenApiExamplesParent

getExamples

Map<String,OpenApiExample> getExamples()

Specified by:

getExamples in interface OpenApiExamplesParent

addExample

void addExample(String name,
                OpenApiExample value)

Specified by:

addExample in interface OpenApiExamplesParent

clearExamples

void clearExamples()

Specified by:

clearExamples in interface OpenApiExamplesParent

removeExample

void removeExample(String name)

Specified by:

removeExample in interface OpenApiExamplesParent

insertExample

void insertExample(String name,
                   OpenApiExample value,
                   int atIndex)

Specified by:

insertExample in interface OpenApiExamplesParent

getExtensions

Map<String,com.fasterxml.jackson.databind.JsonNode> getExtensions()

Specified by:

getExtensions in interface Extensible

addExtension

void addExtension(String name,
                  com.fasterxml.jackson.databind.JsonNode value)

Specified by:

addExtension in interface Extensible

clearExtensions

void clearExtensions()

Specified by:

clearExtensions in interface Extensible

removeExtension

void removeExtension(String name)

Specified by:

removeExtension in interface Extensible

insertExtension

void insertExtension(String name,
                     com.fasterxml.jackson.databind.JsonNode value,
                     int atIndex)

Specified by:

insertExtension in interface Extensible