public class Oas30Document extends OasDocument implements IServerParent
Modifier and Type | Field and Description |
---|---|
Oas30Components |
components |
String |
openapi |
List<Server> |
servers |
paths, security
externalDocs, info, tags
_extensions
_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems
Constructor and Description |
---|
Oas30Document()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addServer(Server server)
Adds a server.
|
Server |
addServer(String url,
String description)
Adds a server.
|
Oas30Components |
createComponents()
Creates an OAS 3.0 Components object.
|
ExternalDocumentation |
createExternalDocumentation()
Creates an External Documentation node.
|
Info |
createInfo()
Creates an Info node.
|
OasPaths |
createPaths()
Creates an OAS Paths object.
|
OasSecurityRequirement |
createSecurityRequirement()
Creates an OAS Security Requirement object.
|
Server |
createServer()
Creates a server.
|
Tag |
createTag()
Creates a Tag node.
|
DocumentType |
getDocumentType()
Called to get the type of document.
|
Server |
getServer(String url)
Gets a server by URL.
|
List<Server> |
getServers()
Gets the list of servers.
|
addSecurityRequirement, getSecurityRequirements, is2xDocument, is3xDocument
accept, addTag, setExternalDocumentation, setExternalDocumentation
addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension
addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute
public String openapi
public Oas30Components components
public final DocumentType getDocumentType()
Document
getDocumentType
in class Document
Document.getDocumentType()
public OasPaths createPaths()
OasDocument
createPaths
in class OasDocument
OasDocument.createPaths()
public OasSecurityRequirement createSecurityRequirement()
ISecurityRequirementParent
createSecurityRequirement
in interface ISecurityRequirementParent
createSecurityRequirement
in class OasDocument
OasDocument.createSecurityRequirement()
public Info createInfo()
Document
createInfo
in class Document
Document.createInfo()
public Tag createTag()
Document
createTag
in class Document
Document.createTag()
public ExternalDocumentation createExternalDocumentation()
Document
createExternalDocumentation
in interface IExternalDocumentationParent
createExternalDocumentation
in class Document
Document.createExternalDocumentation()
public Server createServer()
IServerParent
createServer
in interface IServerParent
IServerParent.createServer()
public Server addServer(String url, String description)
url
- description
- public Oas30Components createComponents()
public void addServer(Server server)
IServerParent
addServer
in interface IServerParent
IServerParent.addServer(io.apicurio.datamodels.core.models.common.Server)
public Server getServer(String url)
IServerParent
getServer
in interface IServerParent
IServerParent.getServer(java.lang.String)
public List<Server> getServers()
IServerParent
getServers
in interface IServerParent
IServerParent.getServers()
Copyright © 2019 Red Hat. All rights reserved.