summaryrefslogtreecommitdiffstats
path: root/docs/openapi/openapi-sdce-6.yaml
blob: 97f4c7e484b820d22aa201cfc3e3223645218bc9 (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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
openapi: 3.0.1
info:
  contact:
    email: onap-discuss@lists.onap.org
    name: ONAP
    url: https://onap.readthedocs.io
  description: SDC API for distribution subscription (SDCE-6)
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  title: "SPC API: SDCE-6"
  version: "1.0"
servers:
- description: SDCE-6 APIs
  url: /sdc
paths:
  /v1/artifactTypes:
    get:
      description: Artifact types list
      operationId: getValidArtifactTypes
      parameters:
      - description: X-ECOMP-RequestID header
        in: header
        name: X-ECOMP-RequestID
        schema:
          type: string
      - description: X-ECOMP-InstanceID header
        in: header
        name: X-ECOMP-InstanceID
        required: true
        schema:
          type: string
      - description: The username and password
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: The username and password
        in: header
        name: Accept
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
          description: Artifact types list fetched successfully
        "400":
          description: Missing  'X-ECOMP-InstanceID'  HTTP header - POL5001
        "401":
          description: ECOMP component  should authenticate itself  and  to  re-send  again  HTTP  request  with
            its Basic Authentication credentials - POL5002
        "403":
          description: ECOMP component is not authorized - POL5003
        "405":
          description: "Method  Not Allowed  :  Invalid HTTP method type used to \
            \ register for  distribution ( POST,PUT,DELETE  will be rejected) - POL4050"
        "500":
          description: The registration failed due to internal SDC problem or Cambria
            Service failure ECOMP Component  should  continue the attempts to  register
            for  distribution - POL5000
      servers:
      - url: /sdc
        variables: {}
      summary: Fetches available artifact types list
      tags:
      - SDCE-6 APIs
  /v1/distributionKafkaData:
    get:
      description: Kafka data
      operationId: getKafkaData
      parameters:
      - description: X-ECOMP-RequestID header
        in: header
        name: X-ECOMP-RequestID
        schema:
          type: string
      - description: X-ECOMP-InstanceID header
        in: header
        name: X-ECOMP-InstanceID
        required: true
        schema:
          type: string
      - description: Determines the format of the body of the response
        in: header
        name: Accept
        schema:
          type: string
      - description: The username and password
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KafkaDataResponse'
          description: ECOMP component is authenticated and kafka endpoint and topic
            list is returned
        "400":
          description: Missing 'X-ECOMP-InstanceID'  HTTP header - POL5001
        "401":
          description: ECOMP component  should authenticate itself  and  to  re-send  again  HTTP  request  with
            its credentials  for  Basic Authentication - POL5002
        "403":
          description: ECOMP component is not authorized - POL5003
        "405":
          description: "Method  Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\
            \ will be rejected) - POL4050"
        "500":
          description: The GET request failed either due to internal SDC problem or
            Cambria Service failure. ECOMP Component should continue the attempts
            to get the needed information - POL5000
      servers:
      - url: /sdc
        variables: {}
      summary: return the kafka cluster and topic list
      tags:
      - SDCE-6 APIs
  /v1/distributionUebCluster:
    get:
      description: UEB Server List
      operationId: getUebServerList
      parameters:
      - description: X-ECOMP-RequestID header
        in: header
        name: X-ECOMP-RequestID
        schema:
          type: string
      - description: X-ECOMP-InstanceID header
        in: header
        name: X-ECOMP-InstanceID
        required: true
        schema:
          type: string
      - description: Determines the format of the body of the response
        in: header
        name: Accept
        schema:
          type: string
      - description: The username and password
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServerListResponse'
          description: ECOMP component is authenticated and list of Cambria API server’s
            FQDNs is returned
        "400":
          description: Missing  'X-ECOMP-InstanceID'  HTTP header - POL5001
        "401":
          description: ECOMP component  should authenticate itself  and  to  re-send  again  HTTP  request  with
            its credentials  for  Basic Authentication - POL5002
        "403":
          description: ECOMP component is not authorized - POL5003
        "405":
          description: "Method  Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\
            \ will be rejected) - POL4050"
        "500":
          description: The GET request failed either due to internal SDC problem or
            Cambria Service failure. ECOMP Component should continue the attempts
            to get the needed information - POL5000
      servers:
      - url: /sdc
        variables: {}
      summary: return the available UEB Server List
      tags:
      - SDCE-6 APIs
  /v1/registerForDistribution:
    post:
      description: Subscription status
      operationId: registerForDistribution
      parameters:
      - description: X-ECOMP-RequestID header
        in: header
        name: X-ECOMP-RequestID
        schema:
          type: string
      - description: X-ECOMP-InstanceID header
        in: header
        name: X-ECOMP-InstanceID
        required: true
        schema:
          type: string
      - description: Determines the format of the body of the response
        in: header
        name: Accept
        schema:
          type: string
      - description: Determines the format of the body of the request
        in: header
        name: Content-Type
        required: true
        schema:
          type: string
      - description: Length  of  the request body
        in: header
        name: Content-Length
        required: true
        schema:
          type: string
      - description: The username and password
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopicRegistrationResponse'
          description: ECOMP component is successfully registered for distribution
        "400":
          description: "Invalid Body :  Specified 'distrEnvName' doesn’t exist - POL4137"
        "401":
          description: ECOMP component  should authenticate itself  and  to  re-send  again  HTTP  request  with
            its Basic Authentication credentials - POL5002
        "403":
          description: ECOMP component is not authorized - POL5003
        "405":
          description: "Method  Not Allowed  :  Invalid HTTP method type used to \
            \ register for  distribution ( PUT,DELETE,GET  will be rejected) - POL4050"
        "500":
          description: The registration failed due to internal SDC problem or Cambria
            Service failure ECOMP Component  should  continue the attempts to  register
            for  distribution - POL5000
      servers:
      - url: /sdc
        variables: {}
      summary: Subscribes for distribution notifications
      tags:
      - SDCE-6 APIs
  /v1/unRegisterForDistribution:
    post:
      description: Subscription status
      operationId: unRegisterForDistribution
      parameters:
      - description: X-ECOMP-RequestID header
        in: header
        name: X-ECOMP-RequestID
        schema:
          type: string
      - description: X-ECOMP-InstanceID header
        in: header
        name: X-ECOMP-InstanceID
        required: true
        schema:
          type: string
      - description: Determines the format of the body of the response
        in: header
        name: Accept
        schema:
          type: string
      - description: Determines the format of the body of the request
        in: header
        name: Content-Type
        required: true
        schema:
          type: string
      - description: Length  of  the request body
        in: header
        name: Content-Length
        required: true
        schema:
          type: string
      - description: The username and password
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopicUnregistrationResponse'
          description: ECOMP component is successfully unregistered
        "400":
          description: "Invalid Body :  Specified 'distrEnvName' doesn’t exist - POL4137"
        "401":
          description: ECOMP component  should authenticate itself  and  to  re-send  again  HTTP  request  with
            its Basic Authentication credentials - POL5002
        "403":
          description: ECOMP component is not authorized - POL5003
        "405":
          description: "Method  Not Allowed  :  Invalid HTTP method type used to \
            \ register for  distribution ( PUT,DELETE,GET will be rejected) - POL4050"
        "500":
          description: The registration failed due to internal SDC problem or Cambria
            Service failure ECOMP Component  should  continue the attempts to  register
            for  distribution - POL5000
      servers:
      - url: /sdc
        variables: {}
      summary: Removes from subscription for distribution notifications
      tags:
      - SDCE-6 APIs
components:
  schemas:
    KafkaDataResponse:
      type: object
      properties:
        distrNotificationTopicName:
          type: string
        distrStatusTopicName:
          type: string
        kafkaBootStrapServer:
          type: string
    RegistrationRequest:
      type: object
      properties:
        apiPublicKey:
          type: string
        distEnvEndPoints:
          type: array
          items:
            type: string
        distrEnvName:
          type: string
        isConsumerToSdcDistrStatusTopic:
          type: boolean
        managerApiPublicKey:
          type: string
        managerApiSecretKey:
          type: string
    ServerListResponse:
      type: object
      properties:
        uebServerList:
          type: array
          items:
            type: string
    TopicRegistrationResponse:
      type: object
      properties:
        distrNotificationTopicName:
          type: string
        distrStatusTopicName:
          type: string
    TopicUnregistrationResponse:
      type: object
      properties:
        distrNotificationTopicName:
          type: string
        distrStatusTopicName:
          type: string
        notificationUnregisterResult:
          type: string
          enum:
          - OK
          - CONNNECTION_ERROR
          - NOT_FOUND
          - TOPIC_ALREADY_EXIST
          - OBJECT_NOT_FOUND
          - INTERNAL_SERVER_ERROR
          - AUTHENTICATION_ERROR
          - UNKNOWN_HOST_ERROR
        statusUnregisterResult:
          type: string
          enum:
          - OK
          - CONNNECTION_ERROR
          - NOT_FOUND
          - TOPIC_ALREADY_EXIST
          - OBJECT_NOT_FOUND
          - INTERNAL_SERVER_ERROR
          - AUTHENTICATION_ERROR
          - UNKNOWN_HOST_ERROR