4 email: onap-discuss@lists.onap.org
6 url: https://onap.readthedocs.io
7 description: SDC API for distribution subscription (SDCE-6)
10 url: http://www.apache.org/licenses/LICENSE-2.0
11 title: "SPC API: SDCE-6"
14 - description: SDCE-6 APIs
19 description: Artifact types list
20 operationId: getValidArtifactTypes
22 - description: X-ECOMP-RequestID header
24 name: X-ECOMP-RequestID
27 - description: X-ECOMP-InstanceID header
29 name: X-ECOMP-InstanceID
33 - description: The username and password
39 - description: The username and password
53 description: Artifact types list fetched successfully
55 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
57 description: ECOMP component should authenticate itself and to re-send again HTTP request with
58 its Basic Authentication credentials - POL5002
60 description: ECOMP component is not authorized - POL5003
62 description: "Method Not Allowed : Invalid HTTP method type used to \
63 \ register for distribution ( POST,PUT,DELETE will be rejected) - POL4050"
65 description: The registration failed due to internal SDC problem or Cambria
66 Service failure ECOMP Component should continue the attempts to register
67 for distribution - POL5000
71 summary: Fetches available artifact types list
74 /v1/distributionKafkaData:
76 description: Kafka data
77 operationId: getKafkaData
79 - description: X-ECOMP-RequestID header
81 name: X-ECOMP-RequestID
84 - description: X-ECOMP-InstanceID header
86 name: X-ECOMP-InstanceID
90 - description: Determines the format of the body of the response
95 - description: The username and password
108 $ref: '#/components/schemas/KafkaDataResponse'
109 description: ECOMP component is authenticated and kafka endpoint and topic
112 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
114 description: ECOMP component should authenticate itself and to re-send again HTTP request with
115 its credentials for Basic Authentication - POL5002
117 description: ECOMP component is not authorized - POL5003
119 description: "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\
120 \ will be rejected) - POL4050"
122 description: The GET request failed either due to internal SDC problem or
123 Cambria Service failure. ECOMP Component should continue the attempts
124 to get the needed information - POL5000
128 summary: return the kafka cluster and topic list
131 /v1/distributionUebCluster:
133 description: UEB Server List
134 operationId: getUebServerList
136 - description: X-ECOMP-RequestID header
138 name: X-ECOMP-RequestID
141 - description: X-ECOMP-InstanceID header
143 name: X-ECOMP-InstanceID
147 - description: Determines the format of the body of the response
152 - description: The username and password
165 $ref: '#/components/schemas/ServerListResponse'
166 description: ECOMP component is authenticated and list of Cambria API server’s
169 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
171 description: ECOMP component should authenticate itself and to re-send again HTTP request with
172 its credentials for Basic Authentication - POL5002
174 description: ECOMP component is not authorized - POL5003
176 description: "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\
177 \ will be rejected) - POL4050"
179 description: The GET request failed either due to internal SDC problem or
180 Cambria Service failure. ECOMP Component should continue the attempts
181 to get the needed information - POL5000
185 summary: return the available UEB Server List
188 /v1/registerForDistribution:
190 description: Subscription status
191 operationId: registerForDistribution
193 - description: X-ECOMP-RequestID header
195 name: X-ECOMP-RequestID
198 - description: X-ECOMP-InstanceID header
200 name: X-ECOMP-InstanceID
204 - description: Determines the format of the body of the response
209 - description: Determines the format of the body of the request
215 - description: Length of the request body
221 - description: The username and password
234 $ref: '#/components/schemas/TopicRegistrationResponse'
235 description: ECOMP component is successfully registered for distribution
237 description: "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137"
239 description: ECOMP component should authenticate itself and to re-send again HTTP request with
240 its Basic Authentication credentials - POL5002
242 description: ECOMP component is not authorized - POL5003
244 description: "Method Not Allowed : Invalid HTTP method type used to \
245 \ register for distribution ( PUT,DELETE,GET will be rejected) - POL4050"
247 description: The registration failed due to internal SDC problem or Cambria
248 Service failure ECOMP Component should continue the attempts to register
249 for distribution - POL5000
253 summary: Subscribes for distribution notifications
256 /v1/unRegisterForDistribution:
258 description: Subscription status
259 operationId: unRegisterForDistribution
261 - description: X-ECOMP-RequestID header
263 name: X-ECOMP-RequestID
266 - description: X-ECOMP-InstanceID header
268 name: X-ECOMP-InstanceID
272 - description: Determines the format of the body of the response
277 - description: Determines the format of the body of the request
283 - description: Length of the request body
289 - description: The username and password
302 $ref: '#/components/schemas/TopicUnregistrationResponse'
303 description: ECOMP component is successfully unregistered
305 description: "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137"
307 description: ECOMP component should authenticate itself and to re-send again HTTP request with
308 its Basic Authentication credentials - POL5002
310 description: ECOMP component is not authorized - POL5003
312 description: "Method Not Allowed : Invalid HTTP method type used to \
313 \ register for distribution ( PUT,DELETE,GET will be rejected) - POL4050"
315 description: The registration failed due to internal SDC problem or Cambria
316 Service failure ECOMP Component should continue the attempts to register
317 for distribution - POL5000
321 summary: Removes from subscription for distribution notifications
329 distrNotificationTopicName:
331 distrStatusTopicName:
333 kafkaBootStrapServer:
346 isConsumerToSdcDistrStatusTopic:
359 TopicRegistrationResponse:
362 distrNotificationTopicName:
364 distrStatusTopicName:
366 TopicUnregistrationResponse:
369 distrNotificationTopicName:
371 distrStatusTopicName:
373 notificationUnregisterResult:
379 - TOPIC_ALREADY_EXIST
381 - INTERNAL_SERVER_ERROR
382 - AUTHENTICATION_ERROR
384 statusUnregisterResult:
390 - TOPIC_ALREADY_EXIST
392 - INTERNAL_SERVER_ERROR
393 - AUTHENTICATION_ERROR