Package io.github.springwolf.asyncapi.v3.model

Class ExternalDocumentation

java.lang.Object

io.github.springwolf.asyncapi.v3.model.ExtendableObject

io.github.springwolf.asyncapi.v3.model.ExternalDocumentation

All Implemented Interfaces:

Reference

public class ExternalDocumentation
extends ExtendableObject
implements Reference

Allows referencing an external resource for extended documentation.

See Also:

• ExternalDocumentation

Field Summary

Fields inherited from class io.github.springwolf.asyncapi.v3.model.ExtendableObject

extensionFields

Constructor Summary

Constructors

Constructor	Description
ExternalDocumentation()

Method Summary

Modifier and Type	Method	Description
String	getRef()	Required.

Methods inherited from class io.github.springwolf.asyncapi.v3.model.ExtendableObject

readExtensionProperty

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalDocumentation

public ExternalDocumentation()

Method Details

getRef

public String getRef()

Description copied from interface: Reference

Required. The reference string.

Specified by:

getRef in interface Reference