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

Interface Reference

All Known Implementing Classes:
ApiKeySecurityScheme, ChannelParameter, ChannelReference, ExternalDocumentation, HttpApiKeySecurityScheme, HttpSecurityScheme, MessageReference, MessageTrait, OAuth2SecurityScheme, OpenIdConnectSecurityScheme, OperationReply, OperationReplyAddress, OperationTraits, SchemaReference, SecurityScheme, Server, ServerReference
public interface Reference
A simple object to allow referencing other components in the specification, internally and externally.

The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules. A JSON Reference SHALL only be used to refer to a schema that is formatted in either JSON or YAML. In the case of a YAML-formatted Schema, the JSON Reference SHALL be applied to the JSON representation of that schema. The JSON representation SHALL be made by applying the conversion described here.

For this specification, reference resolution is done as defined by the JSON Reference specification and not by the JSON Schema specification.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    getRef()
    Required.

  • Method Details

    • getRef

      @NotNull @NotNull String getRef()
      Required. The reference string.