sdntrace/openapi.yml at master · kytos-ng/sdntrace · 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
openapi: '3.0.0'
info:
  version: '1.0.0'
  title: amlight/sdntrace
  description: Create and look up OpenFlow path traces.
servers:
  - url: /api/amlight/sdntrace
paths:
  /v1/trace:
    get:
      summary: List traces
      description: Get all traces available from the database
      operationId: get_results
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/CompleteResult'
    put:
      summary: Run trace
      description: Run an OpenFlow path trace
      operationId: run_trace
      requestBody:
        description: Trace an OpenFlow path in the dataplane
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TraceRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      trace_id:
                        type: integer
                        format: int32
                      error: # This property will show only error messages
                        type: string
        '400':
          description: Bad request.

  /v1/trace/{trace_id}:
    get:
      summary: Get trace details
      description: Request trace details by providing the trace_id
      operationId: get_result
      parameters:
        - name: trace_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/TransportProtocol'
                  - type: object
                    properties:
                      msg:  # This property will show only error messages
                        type: string

  /v1/stats:
    get:
      summary: Get trace statistics
      description: Request trace statistics details
      operationId: get_stats
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Statistics'

  /v1/settings:
    get:
      summary: Get settings
      description: Request settings for sdntrace
      operationId: list_settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'

components:
  schemas:
    Statistics: # Can be referenced via '#/components/schemas/Statistics'
      type: object
      properties:
        number_of_requests:
          type: integer
          format: int32
        number_of_running_traces:
          type: integer
          format: int32
        number_of_pending_traces:
          type: integer
          format: int32
        list_of_pending_traces:
          type: object
          additionalProperties:
                  $ref: '#/components/schemas/CompleteResult'
    CompleteResult: # Can be referenced via '#/components/schemas/CompleteResult'
      type: object
      properties:
        request_id:
          type: integer
          format: int32
        result:
          type: array
          items:
            $ref: '#/components/schemas/TraceResult'
        start_time:
          type: string
          format: date-time
        total_time:
          type: string
          format: date-time
        request:
          $ref: '#/components/schemas/TraceRequest'
    TraceResult: # Can be referenced via '#/components/schemas/TraceResult'
      type: object
      properties:
        type:
          type: string
        dpid:
          type: string
          format: MAC
        port:
          type: integer
        time:
          type: string
          format: date-time
        reason:
          type: string
        msg:
          type: string
    TraceRequest: # Can be referenced via '#/components/schemas/TraceRequest'
      type: object
      required:
        - trace
      properties:
        trace:
          type: object
          required:
          - switch
          properties:
            timeout:
              type: number
              minimum: 0
            switch:
              $ref: '#/components/schemas/Switch'
            eth:
              $ref: '#/components/schemas/Ethernet'
            ip:
              $ref: '#/components/schemas/InternetProtocol'
            tp:
              $ref: '#/components/schemas/TransportProtocol'
    Switch: # Can be referenced via '#/components/schemas/Switch'
      type: object
      required:
        - dpid
        - in_port
      properties:
        dpid:
          type: string
          format: MAC
        in_port:
          type: integer
          format: int32
    Ethernet: # Can be referenced via '#/components/schemas/Ethernet'
      type: object
      properties:
        dl_vlan:
          type: integer
          format: int32
        dl_src:
          type: string
          format: MAC
        dl_dst:
          type: string
          format: MAC
        dl_vlan_pcp:
          type: integer
          format: int32
        dl_type:
          type: integer
          format: int32
    InternetProtocol: # Can be referenced via '#/components/schemas/InternetProtocol'
      type: object
      properties:
        nw_src:
          type: string
          format: dotted-decimal
        nw_dst:
          type: string
          format: dotted-decimal
        nw_tos:
          type: integer
          format: int32
        nw_proto:
          type: integer
          format: int32
    TransportProtocol: # Can be referenced via '#/components/schemas/TransportProtocol'
      type: object
      properties:
        tp_src:
          type: integer
          format: int32
        tp_dst:
          type: integer
          format: int32
    Settings: # Can be referenced via '#/components/schemas/Settings'
      type: object
      properties:
        color_field:
          type: string
        color_value:
          type: string
          format: MAC
        trace_interval:
          type: integer
          format: int32
        parallel_traces:
          type: integer
          format: int32