Package io.openapiparser.model.v31

Class OpenApi

java.lang.Object

io.openapiparser.Properties

io.openapiparser.model.v31.OpenApi

All Implemented Interfaces:

Extensions

public class OpenApi
extends Properties
implements Extensions

the OpenAPI object.

See specification: 4.7.1 OpenAPI Object

Field Summary

Fields inherited from class io.openapiparser.Properties

bucket, context

Constructor Summary

Constructors

Constructor	Description
OpenApi(Context context, io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Summary

Modifier and Type	Method	Description
@Nullable Components	getComponents()
java.util.Map<java.lang.String,java.lang.Object>	getExtensions()	map of all extension properties.
@Nullable ExternalDocumentation	getExternalDocs()
Info	getInfo()
@Nullable java.lang.String	getJsonSchemaDialect()
java.lang.String	getOpenapi()
@Nullable Paths	getPaths()
java.util.Collection<SecurityRequirement>	getSecurity()
java.util.Collection<Server>	getServers()
java.util.Collection<Tag>	getTags()
java.util.Map<java.lang.String,PathItem>	getWebhooks()

Methods inherited from class io.openapiparser.Properties

getBooleanOrDefault, getBooleanOrFalse, getBooleanOrNull, getIntegerOrDefault, getIntegerOrNull, getMapObjectsOrEmpty, getMapObjectsOrEmpty, getMapSetStringsOrEmpty, getMapStringsOrEmpty, getNumberOrNull, getObjectOrNull, getObjectOrThrow, getObjectsOrEmpty, getRawValue, getRawValueOf, getRefObject, getRefObjectOrThrow, getStringOrNull, getStringOrThrow, getStringsOrEmpty, getStringsOrNull, getValueOf, hasProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApi

public OpenApi(Context context,
               io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Detail

getOpenapi

@Required
public java.lang.String getOpenapi()

getInfo

@Required
public Info getInfo()

getJsonSchemaDialect

public @Nullable java.lang.String getJsonSchemaDialect()

getServers

public java.util.Collection<Server> getServers()

getPaths

public @Nullable Paths getPaths()

getWebhooks

public java.util.Map<java.lang.String,PathItem> getWebhooks()

getComponents

public @Nullable Components getComponents()

getSecurity

public java.util.Collection<SecurityRequirement> getSecurity()

getTags

public java.util.Collection<Tag> getTags()

getExternalDocs

public @Nullable ExternalDocumentation getExternalDocs()

getExtensions

public java.util.Map<java.lang.String,java.lang.Object> getExtensions()

Description copied from interface: Extensions

map of all extension properties.

Specified by:

getExtensions in interface Extensions

Overrides:

getExtensions in class Properties

Returns:

map of extension properties