5 "email" : "onap-discuss@lists.onap.org",
7 "url" : "https://onap.readthedocs.io"
9 "description" : "SDC API for distribution subscription (SDCE-6)",
11 "name" : "Apache 2.0",
12 "url" : "http://www.apache.org/licenses/LICENSE-2.0"
14 "title" : "SPC API: SDCE-6",
18 "description" : "SDCE-6 APIs",
22 "/v1/artifactTypes" : {
24 "description" : "Artifact types list",
25 "operationId" : "getValidArtifactTypes",
27 "description" : "X-ECOMP-RequestID header",
29 "name" : "X-ECOMP-RequestID",
34 "description" : "X-ECOMP-InstanceID header",
36 "name" : "X-ECOMP-InstanceID",
42 "description" : "The username and password",
44 "name" : "Authorization",
50 "description" : "The username and password",
61 "application/json" : {
70 "description" : "Artifact types list fetched successfully"
73 "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001"
76 "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002"
79 "description" : "ECOMP component is not authorized - POL5003"
82 "description" : "Method Not Allowed : Invalid HTTP method type used to register for distribution ( POST,PUT,DELETE will be rejected) - POL4050"
85 "description" : "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000"
92 "summary" : "Fetches available artifact types list",
93 "tags" : [ "SDCE-6 APIs" ]
96 "/v1/distributionKafkaData" : {
98 "description" : "Kafka data",
99 "operationId" : "getKafkaData",
101 "description" : "X-ECOMP-RequestID header",
103 "name" : "X-ECOMP-RequestID",
108 "description" : "X-ECOMP-InstanceID header",
110 "name" : "X-ECOMP-InstanceID",
116 "description" : "Determines the format of the body of the response",
123 "description" : "The username and password",
125 "name" : "Authorization",
134 "application/json" : {
138 "$ref" : "#/components/schemas/KafkaDataResponse"
143 "description" : "ECOMP component is authenticated and kafka endpoint and topic list is returned"
146 "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001"
149 "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002"
152 "description" : "ECOMP component is not authorized - POL5003"
155 "description" : "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050"
158 "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"
165 "summary" : "return the kafka cluster and topic list",
166 "tags" : [ "SDCE-6 APIs" ]
169 "/v1/distributionUebCluster" : {
171 "description" : "UEB Server List",
172 "operationId" : "getUebServerList",
174 "description" : "X-ECOMP-RequestID header",
176 "name" : "X-ECOMP-RequestID",
181 "description" : "X-ECOMP-InstanceID header",
183 "name" : "X-ECOMP-InstanceID",
189 "description" : "Determines the format of the body of the response",
196 "description" : "The username and password",
198 "name" : "Authorization",
207 "application/json" : {
211 "$ref" : "#/components/schemas/ServerListResponse"
216 "description" : "ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned"
219 "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001"
222 "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002"
225 "description" : "ECOMP component is not authorized - POL5003"
228 "description" : "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050"
231 "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"
238 "summary" : "return the available UEB Server List",
239 "tags" : [ "SDCE-6 APIs" ]
242 "/v1/registerForDistribution" : {
244 "description" : "Subscription status",
245 "operationId" : "registerForDistribution",
247 "description" : "X-ECOMP-RequestID header",
249 "name" : "X-ECOMP-RequestID",
254 "description" : "X-ECOMP-InstanceID header",
256 "name" : "X-ECOMP-InstanceID",
262 "description" : "Determines the format of the body of the response",
269 "description" : "Determines the format of the body of the request",
271 "name" : "Content-Type",
277 "description" : "Length of the request body",
279 "name" : "Content-Length",
285 "description" : "The username and password",
287 "name" : "Authorization",
296 "application/json" : {
300 "$ref" : "#/components/schemas/TopicRegistrationResponse"
305 "description" : "ECOMP component is successfully registered for distribution"
308 "description" : "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137"
311 "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002"
314 "description" : "ECOMP component is not authorized - POL5003"
317 "description" : "Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050"
320 "description" : "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000"
327 "summary" : "Subscribes for distribution notifications",
328 "tags" : [ "SDCE-6 APIs" ]
331 "/v1/unRegisterForDistribution" : {
333 "description" : "Subscription status",
334 "operationId" : "unRegisterForDistribution",
336 "description" : "X-ECOMP-RequestID header",
338 "name" : "X-ECOMP-RequestID",
343 "description" : "X-ECOMP-InstanceID header",
345 "name" : "X-ECOMP-InstanceID",
351 "description" : "Determines the format of the body of the response",
358 "description" : "Determines the format of the body of the request",
360 "name" : "Content-Type",
366 "description" : "Length of the request body",
368 "name" : "Content-Length",
374 "description" : "The username and password",
376 "name" : "Authorization",
385 "application/json" : {
389 "$ref" : "#/components/schemas/TopicUnregistrationResponse"
394 "description" : "ECOMP component is successfully unregistered"
397 "description" : "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137"
400 "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"
406 "description" : "Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050"
409 "description" : "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000"
416 "summary" : "Removes from subscription for distribution notifications",
417 "tags" : [ "SDCE-6 APIs" ]
423 "KafkaDataResponse" : {
426 "distrNotificationTopicName" : {
429 "distrStatusTopicName" : {
432 "kafkaBootStrapServer" : {
437 "RegistrationRequest" : {
443 "distEnvEndPoints" : {
452 "isConsumerToSdcDistrStatusTopic" : {
455 "managerApiPublicKey" : {
458 "managerApiSecretKey" : {
463 "ServerListResponse" : {
474 "TopicRegistrationResponse" : {
477 "distrNotificationTopicName" : {
480 "distrStatusTopicName" : {
485 "TopicUnregistrationResponse" : {
488 "distrNotificationTopicName" : {
491 "distrStatusTopicName" : {
494 "notificationUnregisterResult" : {
496 "enum" : [ "OK", "CONNNECTION_ERROR", "NOT_FOUND", "TOPIC_ALREADY_EXIST", "OBJECT_NOT_FOUND", "INTERNAL_SERVER_ERROR", "AUTHENTICATION_ERROR", "UNKNOWN_HOST_ERROR" ]
498 "statusUnregisterResult" : {
500 "enum" : [ "OK", "CONNNECTION_ERROR", "NOT_FOUND", "TOPIC_ALREADY_EXIST", "OBJECT_NOT_FOUND", "INTERNAL_SERVER_ERROR", "AUTHENTICATION_ERROR", "UNKNOWN_HOST_ERROR" ]