Package io.openapiparser.model.v31

Class ExternalDocumentation

java.lang.Object

io.openapiparser.Properties

io.openapiparser.model.v31.ExternalDocumentation

All Implemented Interfaces:

Extensions

public class ExternalDocumentation
extends Properties
implements Extensions

the External Documentation object.

See specification: 4.8.11 External Documentation Object

Field Summary

Fields inherited from class io.openapiparser.Properties

bucket, context

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@Nullable java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.Object>	getExtensions()	map of all extension properties.
java.lang.String	getUrl()

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

ExternalDocumentation

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

Method Detail

getDescription

public @Nullable java.lang.String getDescription()

getUrl

@Required
public java.lang.String getUrl()

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