Package com.asyncapi.schemas.asyncapi

Class ExtendableObject

java.lang.Object
com.asyncapi.schemas.asyncapi.ExtendableObject
Direct Known Subclasses:
AsyncAPI, AsyncAPI, AsyncAPI, AsyncAPISchema, Channel, ChannelBinding, ChannelItem, ChannelItem, Components, Components, Components, Contact, Contact, Contact, CorrelationId, CorrelationId, CorrelationId, ExternalDocumentation, ExternalDocumentation, ExternalDocumentation, Info, Info, Info, License, License, License, Message, Message, Message, MessageBinding, MessageExample, MessageExample, MessageTrait, MessageTrait, MessageTrait, MultiFormatSchema, OAuthFlow, OAuthFlow, OAuthFlows, OAuthFlows, Operation, Operation, Operation, OperationBinding, OperationReply, OperationReplyAddress, OperationTrait, OperationTrait, OperationTrait, Parameter, Parameter, Parameter, SecurityScheme, SecurityScheme, Server, Server, Server, ServerBinding, ServerVariable, ServerVariable, ServerVariable, Tag, Tag, Tag
public class ExtendableObject extends Object
While the AsyncAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

The extensions properties are implemented as patterned fields that are always prefixed by "x-".

The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced).

Version:
3.0.0
Author:
Pavel Bodiachevskii
See Also:

  • Field Details

    • extensionPropertyNamePattern

      public static final Pattern extensionPropertyNamePattern

    • extensionFields

      @Nullable protected @Nullable Map<String,Object> extensionFields
      Extension fields in the form x-extension-field-name for the exposed API.

  • Constructor Details

    • ExtendableObject

      public ExtendableObject()

  • Method Details

    • readExtensionProperty

      protected final void readExtensionProperty(String name, Object value)