async-apis/json-schema/asyncapi-operation-schema.json at main · api-evangelist/async-apis · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/async-apis/refs/heads/main/json-schema/asyncapi-operation-schema.json",
  "title": "AsyncAPI Operation",
  "description": "An AsyncAPI 3.x Operation — describes an action (send or receive) the application performs on a referenced channel. Operations are first-class in 3.0, separated from channels.",
  "type": "object",
  "required": ["action", "channel"],
  "properties": {
    "action": {
      "type": "string",
      "description": "The action the application performs. `send` = the application produces messages to the channel. `receive` = the application consumes messages from the channel.",
      "enum": ["send", "receive"]
    },
    "channel": {
      "type": "object",
      "description": "Reference Object pointing to the channel this operation targets. Typically `{ \"$ref\": \"#/channels/userSignedUp\" }`.",
      "properties": {
        "$ref": {"type": "string"}
      },
      "required": ["$ref"]
    },
    "title": {
      "type": "string"
    },
    "summary": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "security": {
      "type": "array",
      "description": "Security requirements applied to this operation.",
      "items": {"type": "object"}
    },
    "tags": {
      "type": "array",
      "items": {"type": "object"}
    },
    "externalDocs": {
      "type": "object"
    },
    "bindings": {
      "type": "object",
      "description": "Protocol-specific operation bindings (kafka.groupId, mqtt.qos, amqp.expiration, etc.).",
      "properties": {
        "kafka": {"type": "object"},
        "mqtt": {"type": "object"},
        "amqp": {"type": "object"},
        "ws": {"type": "object"},
        "nats": {"type": "object"},
        "http": {"type": "object"},
        "jms": {"type": "object"},
        "pulsar": {"type": "object"},
        "ibmmq": {"type": "object"}
      }
    },
    "traits": {
      "type": "array",
      "description": "List of operation traits merged into the operation (reusable fragments).",
      "items": {"type": "object"}
    },
    "messages": {
      "type": "array",
      "description": "Subset of messages from the referenced channel that this operation handles. Each item is a Reference Object pointing into the channel's messages map.",
      "items": {"type": "object"}
    },
    "reply": {
      "type": "object",
      "description": "Defines a request/reply pattern: the channel + messages used for the reply.",
      "properties": {
        "address": {"type": "object"},
        "channel": {"type": "object"},
        "messages": {"type": "array"}
      }
    }
  }
}