HTTP

The HTTP binding. The emitted member is http, and every object carries bindingVersion: 0.3.0.

@httpOperation

extern dec httpOperation(target: Operation, config: valueof AsyncAPIHttpOperationBinding);

Field	Type	Required
method	string	no
query	unknown	no

Apply it to an operation that carries @send or @receive.

method is one of GET, PUT, POST, PATCH, DELETE, HEAD, OPTIONS, CONNECT and TRACE.

query is a Schema Object of type object with a properties key. AsyncAPI states both requirements.

@send
@httpOperation(#{
  method: "POST",
  query: #{ type: "object", properties: #{ tenant: #{ type: "string" } } }
})
op notify(event: OrderCreated): void;

operations:
  notify:
    action: send
    channel:
      $ref: "#/channels/webhooks.orders"
    bindings:
      http:
        method: POST
        query:
          type: object
          properties:
            tenant:
              type: string
        bindingVersion: 0.3.0

@httpMessage

extern dec httpMessage(target: Model, config: valueof AsyncAPIHttpMessageBinding);

Field	Type	Required
headers	unknown	no
statusCode	int32	no

Apply it to a model that also carries @message.

headers is a Schema Object of type object with a properties key.

statusCode is a status code from RFC 9110, so it is between 100 and 599. AsyncAPI states that it applies only to a message named by an Operation Reply Object. The emitter does not check that rule, because it spans two objects.

@message
@httpMessage(#{
  headers: #{ type: "object", properties: #{ `X-Correlation-Id`: #{ type: "string" } } },
  statusCode: 202
})
model OrderCreated {
  orderId: string;
}

components:
  messages:
    OrderCreated:
      name: OrderCreated
      payload:
        $ref: "#/components/schemas/OrderCreated"
      bindings:
        http:
          headers:
            type: object
            properties:
              X-Correlation-Id:
                type: string
          statusCode: 202
          bindingVersion: 0.3.0