summaryrefslogtreecommitdiffstats
path: root/sliapi/model/src/main/resources/sli-api.20161110.yaml
blob: 3420c66b5de8f7285ca38a0d5b373e581b9d8d89 (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
---
swagger: '2.0'
info:
  version: 1.0.0
  title: "SLI API"
basePath: '/restconf'
schemes:
  - http
  - https
paths:
  '/restconf/config/SLI-API:test-results':
    delete:
      produces:
        - application/json
        - application/xml
      responses:
        '200':
          description: No response was specified
      description: Test results
      operationId: delete-test-results
    get:
      produces:
        - application/json
        - application/xml
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/test-results'
      description: Test results
      operationId: get-test-results
    post:
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      parameters:
        - in: body
          name: testResults
          required: false
          schema:
            $ref: '#/definitions/test-results'
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/test-results'
      description: Test results
      operationId: post-test-results
    put:
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      parameters:
        - in: body
          name: testResults
          required: false
          schema:
            $ref: '#/definitions/test-results'
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/test-results'
      description: Test results
      operationId: put-test-results

  '/restconf/config/SLI-API:test-results/test-result/{test-identifier}':
    delete:
      produces:
        - application/json
        - application/xml
      parameters:
        - in: path
          name: test-identifier
          required: true
          type: string
      responses:
        '200':
          description: No response was specified
      operationId: delete-test-result
    get:
      produces:
        - application/json
        - application/xml
      parameters:
        - in: path
          name: test-identifier
          required: true
          type: string
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/test-result'
      operationId: get-test-result
    put:
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      parameters:
        - in: path
          name: test-identifier
          required: true
          type: string
        - in: body
          name: testResult
          required: false
          schema:
            $ref: '#/definitions/test-result'
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/test-result'
      operationId: PUT-test-result

  '/restconf/operational/SLI-API:test-results':
    get:
      produces:
        - application/json
        - application/xml
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/test-results'
      description: Test results
      operationId: GET-test-results
  '/restconf/operations/SLI-API:execute-graph':
    post:
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      parameters:
        - in: body
          name: executeGraphInput
          required: false
          schema:
            $ref: '#/definitions/execute-graph-input'
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/response-fields'
      description: ' Method to add a new parameter.'
      operationId: execute-graph
  '/restconf/operations/SLI-API:healthcheck':
    post:
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/response-fields'
      operationId: healthcheck
  '/restconf/operations/SLI-API:vlbcheck':
    post:
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: '#/definitions/response-fields'
      operationId: vlbcheck

definitions:
  parameter-setting:
    type: object
    properties:
      parameter-name:
        type: string
      int-value:
        type: integer
      string-value:
        type: string
      boolean-value:
        type: boolean

  response-fields:
    type: object
    properties:
      response-code:
        type: string
      ack-final-indicator:
        type: string
      response-message:
        type: string
      context-memory-json:
        type: string

  test-results:
    type: object
    properties:
      test-results:
        type: array
        items:
          $ref: '#/definitions/test-result'

  test-result:
    type: object
    properties:
      test-identifier:
        type: string
      results:
        type: array
        items:
          type: string

  execute-graph-input:
    properties:
      'input':
        type: object
        properties:
          'mode':
             type: string
          'module-name':
            type: string
          'rpc-name':
            type: string
          'sli-parameter':
            items:
              $ref: '#/definitions/parameter-setting'
            type: array
    type: object






  unique_empty_identifier: {}