api-spec/internal/asyncapi.yml at main · cycleplatform/api-spec · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
asyncapi: "3.0.0"

info:
  title: Cycle Internal Async API
  version: "1.0.0"
  description: |
    Internal notifications documentation over the internal API socket running inside all container instances on the Cycle platform at /var/run/cycle/api/api.sock.

servers:
  socket:
    host: /var/run/cycle/api/api.sock
    protocol: ws+unix
    description: Cycle's internal API socket

channels:
  root:
    address: /
    messages:
      notification:
        $ref: "#/components/messages/notification"
    bindings:
      ws:
        headers:
          type: object
          properties:
            x-cycle-token:
              type: string

operations:
  notificationListener:
    action: receive
    channel:
      $ref: "#/channels/root"
    messages:
      - $ref: "#/channels/root/messages/notification"

components:
  messages:
    notification:
      summary: A notification object sent from the platform.
      payload:
        $ref: "#/components/schemas/notification"

  schemas:
    notification:
      type: object
      required:
        - topic
        - object
        - context
      properties:
        topic:
          type: string
          description: The topic of the notification.
          enum:
            - dns.zone.certificate.ready
            - dns.zone.reconfigured
            - dns.zone.records.reconfigured
            - dns.zone.verified
            - container.instances.reconfigured
            - container.state.changed
            - container.reconfigured
            - environment.services.reconfigured
            - environment.deployments.reconfigured
            - environment.services.lb.ips.modified
            - sdn.network.reconfigured
            - sdn.network.created
        object:
          type: object
          properties:
            id:
              type: string
            state:
              type: string
            previous_state:
              type: string
            error:
              type: string
        context:
          type: object
          properties:
            label:
              type: string
            hub_id:
              type: string
            account_id:
              type: string
            environments:
              type: array
              items:
                type: string
            dns_zones:
              type: array
              items:
                type: string
            clusters:
              type: array
              items:
                type: string
            containers:
              type: array
              items:
                type: string
        flags:
          type: object
          additionalProperties:
            type: string
        annotations:
          type: object
          additionalProperties:
            type: string