nori_asyncapi - v0.4.0

nori_asyncapi/document

AsyncAPI 3.x document model.

Root object of an AsyncAPI spec. Mirrors the parts of the 3.1.0 spec the generators need: info, servers, channels, operations, components. Message payloads are kept as raw Dynamic — they are plain JSON Schema and get handed to nori.parse_schema at IR-build time so the schema engine stays single-sourced in nori.

Types

Action

</>

Operation action — direction from the application’s point of view.

pub type Action {
  Send
  Receive
}

Constructors 

  • Send
  • Receive

Channel

</>

Channel object — a named address messages flow over.

pub type Channel {
  Channel(
    address: option.Option(String),
    title: option.Option(String),
    summary: option.Option(String),
    description: option.Option(String),
    messages: dict.Dict(String, MessageOrRef),
    parameters: dict.Dict(String, Parameter),
    servers: List(String),
  )
}

Constructors 

  • Channel(
  address: option.Option(String),
  title: option.Option(String),
  summary: option.Option(String),
  description: option.Option(String),
  messages: dict.Dict(String, MessageOrRef),
  parameters: dict.Dict(String, Parameter),
  servers: List(String),
)

    Arguments

    messages

    Named messages available on this channel. Value is a message OR a ref.

    parameters

    Channel-level parameters (address templating, e.g. {id}).

    servers

    $ref strings of servers this channel is restricted to.

Components

</>

Reusable components. Only the buckets the generators consume are modelled; the rest of the spec’s component buckets are ignored for now.

pub type Components {
  Components(
    messages: dict.Dict(String, Message),
    schemas: dict.Dict(String, dynamic.Dynamic),
    channels: dict.Dict(String, Channel),
    parameters: dict.Dict(String, Parameter),
  )
}

Constructors

Document

</>

The root AsyncAPI object.

pub type Document {
  Document(
    asyncapi: String,
    id: option.Option(String),
    info: Info,
    default_content_type: option.Option(String),
    servers: dict.Dict(String, Server),
    channels: dict.Dict(String, Channel),
    operations: dict.Dict(String, Operation),
    components: Components,
  )
}

Constructors

Info

</>

Info object — API metadata.

pub type Info {
  Info(
    title: String,
    version: String,
    description: option.Option(String),
  )
}

Constructors 

  • Info(
  title: String,
  version: String,
  description: option.Option(String),
)

Message

</>

Message object. payload is raw JSON Schema (Dynamic) resolved later.

pub type Message {
  Message(
    name: option.Option(String),
    title: option.Option(String),
    summary: option.Option(String),
    description: option.Option(String),
    content_type: option.Option(String),
    payload: option.Option(dynamic.Dynamic),
    headers: option.Option(dynamic.Dynamic),
  )
}

Constructors

MessageOrRef

</>

A message that is either inline or a $ref.

pub type MessageOrRef {
  InlineMessage(Message)
  MessageRef(String)
}

Constructors 

  • InlineMessage(Message)
  • MessageRef(String)

Operation

</>

Operation object — an action (send/receive) bound to a channel.

pub type Operation {
  Operation(
    action: Action,
    channel_ref: String,
    title: option.Option(String),
    summary: option.Option(String),
    description: option.Option(String),
    message_refs: List(String),
  )
}

Constructors 

  • Operation(
  action: Action,
  channel_ref: String,
  title: option.Option(String),
  summary: option.Option(String),
  description: option.Option(String),
  message_refs: List(String),
)

    Arguments

    channel_ref

    $ref to the channel this operation acts on.

    message_refs

    $ref strings of the messages this operation carries.

Parameter

</>

Parameter object — a channel address variable.

pub type Parameter {
  Parameter(
    description: option.Option(String),
    enum_values: List(String),
    default: option.Option(String),
    location: option.Option(String),
  )
}

Constructors

Server

</>

Server object. protocol drives which transport a generator emits.

pub type Server {
  Server(
    host: String,
    protocol: String,
    pathname: option.Option(String),
    description: option.Option(String),
  )
}

Constructors

Values

action_from_string

</> 
pub fn action_from_string(s: String) -> Action

Parse an action string. Unknown values default to Receive (server pushes nothing) so a malformed spec fails safe rather than emitting a sender.

empty_components

</> 
pub fn empty_components() -> Components

An empty components bag.

new

</> 
pub fn new(asyncapi: String, info: Info) -> Document

An empty document with only the required fields set.

✨ Search Document