summaryrefslogtreecommitdiffstats
path: root/sliapi/model/swagger/src/main/yaml/sliapi.yaml
blob: df434964f86b3a29160ca435f59a45e24e59b89a (plain)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
---
swagger: "2.0"
info:
  description: "This module contains a collection of generally useful derived\nYANG\
    \ data types.\n\nCopyright (c) 2013 IETF Trust and the persons identified as\n\
    authors of the code.  All rights reserved.\n\nRedistribution and use in source\
    \ and binary forms, with or\nwithout modification, is permitted pursuant to, and\
    \ subject\nto the license terms contained in, the Simplified BSD License\nset\
    \ forth in Section 4.c of the IETF Trust's Legal Provisions\nRelating to IETF\
    \ Documents\n(http://trustee.ietf.org/license-info).\n\nThis version of this YANG\
    \ module is part of RFC 6991; see\nthe RFC itself for full legal notices.,This\
    \ module contains a collection of generally useful derived\nYANG data types for\
    \ Internet addresses and related things.\n\nCopyright (c) 2013 IETF Trust and\
    \ the persons identified as\nauthors of the code.  All rights reserved.\n\nRedistribution\
    \ and use in source and binary forms, with or\nwithout modification, is permitted\
    \ pursuant to, and subject\nto the license terms contained in, the Simplified\
    \ BSD License\nset forth in Section 4.c of the IETF Trust's Legal Provisions\n\
    Relating to IETF Documents\n(http://trustee.ietf.org/license-info).\n\nThis version\
    \ of this YANG module is part of RFC 6991; see\nthe RFC itself for full legal\
    \ notices.,Defines API to service logic interpreter"
  version: "1.0.1-SNAPSHOT"
  title: "ietf-yang-types,ietf-inet-types,SLI-API API"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/json"
- "application/xml"
paths:
  /config/SLI-API:test-results/:
    get:
      tags:
      - "SLI-API"
      description: "returns sli.api.TestResults"
      parameters: []
      responses:
        400:
          description: "Internal error"
        200:
          description: "sli.api.TestResults"
          responseSchema:
            originalRef: "#/definitions/sli.api.TestResults"
            $ref: "#/definitions/sli.api.TestResults"
          schema:
            originalRef: "#/definitions/sli.api.TestResults"
            $ref: "#/definitions/sli.api.TestResults"
    post:
      tags:
      - "SLI-API"
      description: "creates sli.api.TestResults"
      parameters:
      - in: "body"
        name: "sli.api.TestResults.body-param"
        description: "sli.api.TestResults to be added to list"
        required: false
        schema:
          originalRef: "#/definitions/sli.api.TestResults"
          $ref: "#/definitions/sli.api.TestResults"
      responses:
        400:
          description: "Internal error"
        201:
          description: "Object created"
        409:
          description: "Object already exists"
    put:
      tags:
      - "SLI-API"
      description: "creates or updates sli.api.TestResults"
      parameters:
      - in: "body"
        name: "sli.api.TestResults.body-param"
        description: "sli.api.TestResults to be added or updated"
        required: false
        schema:
          originalRef: "#/definitions/sli.api.TestResults"
          $ref: "#/definitions/sli.api.TestResults"
      responses:
        400:
          description: "Internal error"
        201:
          description: "Object created"
        204:
          description: "Object modified"
    delete:
      tags:
      - "SLI-API"
      description: "removes sli.api.TestResults"
      parameters: []
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /config/SLI-API:test-results/SLI-API:test-result/:
    post:
      description: "creates sli.api.testresults.TestResult"
      parameters:
      - in: "body"
        name: "sli.api.testresults.TestResult.body-param"
        description: "sli.api.testresults.TestResult to be added to list"
        required: false
        schema:
          originalRef: "#/definitions/sli.api.testresults.TestResult"
          $ref: "#/definitions/sli.api.testresults.TestResult"
      responses:
        400:
          description: "Internal error"
        201:
          description: "Object created"
        409:
          description: "Object already exists"
  /config/SLI-API:test-results/SLI-API:test-result/{test-identifier}/:
    get:
      tags:
      - "SLI-API"
      description: "returns sli.api.testresults.TestResult"
      parameters:
      - name: "test-identifier"
        in: "path"
        description: "Id of test-result"
        required: true
        type: "string"
      responses:
        400:
          description: "Internal error"
        200:
          description: "sli.api.testresults.TestResult"
          responseSchema:
            originalRef: "#/definitions/sli.api.testresults.TestResult"
            $ref: "#/definitions/sli.api.testresults.TestResult"
          schema:
            originalRef: "#/definitions/sli.api.testresults.TestResult"
            $ref: "#/definitions/sli.api.testresults.TestResult"
    post:
      tags:
      - "SLI-API"
      description: "creates sli.api.testresults.TestResult"
      parameters:
      - name: "test-identifier"
        in: "path"
        description: "Id of test-result"
        required: true
        type: "string"
      - in: "body"
        name: "sli.api.testresults.TestResult.body-param"
        description: "sli.api.testresults.TestResult to be added to list"
        required: false
        schema:
          originalRef: "#/definitions/sli.api.testresults.TestResult"
          $ref: "#/definitions/sli.api.testresults.TestResult"
      responses:
        400:
          description: "Internal error"
        201:
          description: "Object created"
        409:
          description: "Object already exists"
    put:
      tags:
      - "SLI-API"
      description: "creates or updates sli.api.testresults.TestResult"
      parameters:
      - name: "test-identifier"
        in: "path"
        description: "Id of test-result"
        required: true
        type: "string"
      - in: "body"
        name: "sli.api.testresults.TestResult.body-param"
        description: "sli.api.testresults.TestResult to be added or updated"
        required: false
        schema:
          originalRef: "#/definitions/sli.api.testresults.TestResult"
          $ref: "#/definitions/sli.api.testresults.TestResult"
      responses:
        400:
          description: "Internal error"
        201:
          description: "Object created"
        204:
          description: "Object modified"
    delete:
      tags:
      - "SLI-API"
      description: "removes sli.api.testresults.TestResult"
      parameters:
      - name: "test-identifier"
        in: "path"
        description: "Id of test-result"
        required: true
        type: "string"
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /operational/SLI-API:test-results/:
    get:
      tags:
      - "SLI-API"
      description: "returns sli.api.TestResults"
      parameters: []
      responses:
        400:
          description: "Internal error"
        200:
          description: "sli.api.TestResults"
          responseSchema:
            originalRef: "#/definitions/sli.api.TestResults"
            $ref: "#/definitions/sli.api.TestResults"
          schema:
            originalRef: "#/definitions/sli.api.TestResults"
            $ref: "#/definitions/sli.api.TestResults"
  /operational/SLI-API:test-results/SLI-API:test-result/{test-identifier}/:
    get:
      tags:
      - "SLI-API"
      description: "returns sli.api.testresults.TestResult"
      parameters:
      - name: "test-identifier"
        in: "path"
        description: "Id of test-result"
        required: true
        type: "string"
      responses:
        400:
          description: "Internal error"
        200:
          description: "sli.api.testresults.TestResult"
          responseSchema:
            originalRef: "#/definitions/sli.api.testresults.TestResult"
            $ref: "#/definitions/sli.api.testresults.TestResult"
          schema:
            originalRef: "#/definitions/sli.api.testresults.TestResult"
            $ref: "#/definitions/sli.api.testresults.TestResult"
  /operations/SLI-API:execute-graph/:
    post:
      tags:
      - "SLI-API"
      parameters:
      - in: "body"
        name: "sli.api.executegraph.Input.body-param"
        required: false
        schema:
          properties:
            input:
              originalRef: "#/definitions/sli.api.executegraph.Input"
              $ref: "#/definitions/sli.api.executegraph.Input"
      responses:
        400:
          description: "Internal error"
        200:
          description: "Correct response"
          responseSchema:
            originalRef: "#/definitions/sli.api.ExecuteGraph"
            $ref: "#/definitions/sli.api.ExecuteGraph"
          schema:
            originalRef: "#/definitions/sli.api.ExecuteGraph"
            $ref: "#/definitions/sli.api.ExecuteGraph"
        201:
          description: "No response"
  /operations/SLI-API:healthcheck/:
    post:
      tags:
      - "SLI-API"
      parameters: []
      responses:
        400:
          description: "Internal error"
        200:
          description: "Correct response"
          responseSchema:
            originalRef: "#/definitions/sli.api.Healthcheck"
            $ref: "#/definitions/sli.api.Healthcheck"
          schema:
            originalRef: "#/definitions/sli.api.Healthcheck"
            $ref: "#/definitions/sli.api.Healthcheck"
        201:
          description: "No response"
  /operations/SLI-API:vlbcheck/:
    post:
      tags:
      - "SLI-API"
      parameters: []
      responses:
        400:
          description: "Internal error"
        200:
          description: "Correct response"
          responseSchema:
            originalRef: "#/definitions/sli.api.Vlbcheck"
            $ref: "#/definitions/sli.api.Vlbcheck"
          schema:
            originalRef: "#/definitions/sli.api.Vlbcheck"
            $ref: "#/definitions/sli.api.Vlbcheck"
        201:
          description: "No response"
definitions:
  sli.api.ExecuteGraph:
    type: "object"
    properties:
      output:
        originalRef: "#/definitions/sli.api.ResponseFields"
        $ref: "#/definitions/sli.api.ResponseFields"
  sli.api.Healthcheck:
    type: "object"
    properties:
      output:
        originalRef: "#/definitions/sli.api.ResponseFields"
        $ref: "#/definitions/sli.api.ResponseFields"
  sli.api.ModeEnumeration:
    type: "string"
    enum:
    - "sync"
    - "async"
  sli.api.ParameterSetting:
    type: "object"
    properties:
      string-value:
        type: "string"
      boolean-value:
        type: "boolean"
      parameter-name:
        type: "string"
        description: "Parameter name"
      int-value:
        type: "integer"
        format: "int32"
  sli.api.ResponseFields:
    type: "object"
    properties:
      response-code:
        type: "string"
      response-message:
        type: "string"
      context-memory-json:
        type: "string"
      ack-final-indicator:
        type: "string"
  sli.api.TestResults:
    type: "object"
    properties:
      test-result:
        type: "array"
        items:
          originalRef: "#/definitions/sli.api.testresults.TestResult"
          $ref: "#/definitions/sli.api.testresults.TestResult"
  sli.api.Vlbcheck:
    type: "object"
    properties:
      output:
        originalRef: "#/definitions/sli.api.ResponseFields"
        $ref: "#/definitions/sli.api.ResponseFields"
  sli.api.executegraph.Input:
    type: "object"
    properties:
      mode:
        originalRef: "#/definitions/sli.api.ModeEnumeration"
        $ref: "#/definitions/sli.api.ModeEnumeration"
      module-name:
        type: "string"
      sli-parameter:
        type: "array"
        items:
          originalRef: "#/definitions/sli.api.ParameterSetting"
          $ref: "#/definitions/sli.api.ParameterSetting"
      rpc-name:
        type: "string"
  sli.api.testresults.TestResult:
    type: "object"
    properties:
      results:
        type: "array"
        items:
          type: "string"
      test-identifier:
        type: "string"