asyncapi

Documentation

Index

• type Any
  • func (a Any) IsFieldRequired()
• type Channel
  • func (c Channel) GetChannelMessage() *Message
  • func (c *Channel) Process(spec Specification)
• type Components
  • func (c *Components) Process(spec Specification)
• type CorrelationID
• type Info
• type Items
• type Message
  • func (msg *Message) Process(spec Specification)
• type Operation
• type Specification
  • func (s Specification) GetPublishSubscribeCount() (publishCount, subscribeCount uint)
  • func (s *Specification) Process()
  • func (s Specification) ReferenceMessage(ref string) Message

Types

type Any

type Any struct {
	Type        string         `json:"type"`
	Description string         `json:"description"`
	Format      string         `json:"format"`
	Properties  map[string]Any `json:"properties"`
	Items       Items          `json:"items"`
	Reference   string         `json:"$ref"`
	Required    []string       `json:"required"`

	// Non AsyncAPI fields
	Name string `json:"-"`
}

func (Any) IsFieldRequired

func (a Any) IsFieldRequired()

type Channel

type Channel struct {
	Subscribe *Operation `json:"subscribe"`
	Publish   *Operation `json:"publish"`

	// Non AsyncAPI fields
	Name string `json:"-"`
}

func (Channel) GetChannelMessage

func (c Channel) GetChannelMessage() *Message

GetChannelMessage will return the channel message WARNING: if there is a reference, then it won't be followed.

func (*Channel) Process

func (c *Channel) Process(spec Specification)

type Components

type Components struct {
	Messages map[string]Message `json:"messages"`
	Schemas  map[string]Any     `json:"schemas"`
}

func (*Components) Process

func (c *Components) Process(spec Specification)

type CorrelationID

type CorrelationID struct {
	Description string `json:"description"`
	Location    string `json:"location"`
}

type Info

type Info struct {
	Title       string `json:"title"`
	Version     string `json:"version"`
	Description string `json:"description"`
}

type Items

type Items struct {
	Type string `json:"type"`

	Reference string `json:"$ref"`
}

type Message

type Message struct {
	Description   string         `json:"description"`
	Headers       *Any           `json:"headers"`
	Payload       *Any           `json:"payload"`
	CorrelationID *CorrelationID `json:"correlationID"`
	Reference     string         `json:"$ref"`

	// --- Non AsyncAPI fields -------------------------------------------------
	Name string `json:"-"`

	// CorrelationIDLocation will indicate where the correlation id is
	// According to: https://www.asyncapi.com/docs/reference/specification/v2.6.0#correlationIDObject
	CorrelationIDLocation string `json:"-"`
	CorrelationIDRequired bool   `json:"-"`
}

func (*Message) Process

func (msg *Message) Process(spec Specification)

type Operation

type Operation struct {
	Message Message `json:"message"`
}

type Specification

type Specification struct {
	Version    string             `json:"asyncapi"`
	Info       Info               `json:"info"`
	Channels   map[string]Channel `json:"channels"`
	Components Components         `json:"components"`
}

func (Specification) GetPublishSubscribeCount

func (s Specification) GetPublishSubscribeCount() (publishCount, subscribeCount uint)

func (*Specification) Process

func (s *Specification) Process()

func (Specification) ReferenceMessage

func (s Specification) ReferenceMessage(ref string) Message