Package io.apicurio.datamodels.models.openapi

Interface OpenApiDocument

All Superinterfaces:

Document, Node, Visitable

All Known Subinterfaces:

OpenApi20Document, OpenApi30Document, OpenApi31Document

All Known Implementing Classes:

OpenApi20DocumentImpl, OpenApi30DocumentImpl, OpenApi31DocumentImpl

public interface OpenApiDocument
extends Document

Method Summary

Modifier and Type	Method	Description
void	addTag(OpenApiTag value)
void	clearTags()
OpenApiExternalDocumentation	createExternalDocumentation()
OpenApiPaths	createPaths()
OpenApiTag	createTag()
OpenApiExternalDocumentation	getExternalDocs()
OpenApiPaths	getPaths()
List<OpenApiTag>	getTags()
void	insertTag(OpenApiTag value, int atIndex)
void	removeTag(OpenApiTag value)
void	setExternalDocs(OpenApiExternalDocumentation value)
void	setPaths(OpenApiPaths value)

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

createInfo, getInfo, setInfo

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

getPaths

OpenApiPaths getPaths()

setPaths

void setPaths(OpenApiPaths value)

createPaths

OpenApiPaths createPaths()

createTag

OpenApiTag createTag()

getTags

List<OpenApiTag> getTags()

addTag

void addTag(OpenApiTag value)

clearTags

void clearTags()

removeTag

void removeTag(OpenApiTag value)

insertTag

void insertTag(OpenApiTag value,
               int atIndex)

getExternalDocs

OpenApiExternalDocumentation getExternalDocs()

setExternalDocs

void setExternalDocs(OpenApiExternalDocumentation value)

createExternalDocumentation

OpenApiExternalDocumentation createExternalDocumentation()