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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
{
"swagger" : "2.0",
"info" : {
"version" : "2.3.0-SNAPSHOT",
"title" : "cmso-topology"
},
"basePath" : "/topology",
"tags" : [ {
"name" : "Administration"
}, {
"name" : "Topology Interface"
} ],
"paths" : {
"/{apiVersion}/admin/{id}" : {
"get" : {
"tags" : [ "Administration" ],
"summary" : "",
"description" : "Returns encrypted value of id.",
"operationId" : "exec",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "apiVersion",
"in" : "path",
"description" : "v1|v2",
"required" : true,
"type" : "string",
"default" : "v1"
}, {
"name" : "id",
"in" : "path",
"description" : "Identifier",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK",
"schema" : {
"type" : "string"
}
},
"400" : {
"description" : "Request failed"
}
}
}
},
"/{apiVersion}/current" : {
"post" : {
"tags" : [ "Topology Interface" ],
"summary" : "Request Topology",
"description" : "API to retrieve toplogy for scheduling 'conflict free' mainentance. Retrieves the element information related to the list of elements targeted for mainenance activity. Scope of related elements to be returned are defined in the passed ToplogogyRequest. Elements returned must include in the elementData, the identifier that the element is known as in the ticket management system.\nThe Topology Service may implement asynchronous requests by returning IN_PROGRESS status. If IN_PROGRESS, the optimizer will begin polling until COMPLETED is returned with the response. ",
"operationId" : "retrieveCurrentTopology",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "apiVersion",
"in" : "path",
"description" : "v1",
"required" : true,
"type" : "string",
"default" : "v1"
}, {
"in" : "body",
"name" : "body",
"description" : "Topology criteria.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Topology Request"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"schema" : {
"$ref" : "#/definitions/Topology Response"
}
},
"400" : {
"description" : "Bad request",
"schema" : {
"$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
"description" : "Unexpected Runtime error"
}
}
}
},
"/{apiVersion}/current/request/{id}" : {
"get" : {
"tags" : [ "Topology Interface" ],
"summary" : "Poll Asynchronous Topology Request",
"description" : "If a topology request results in asynchronous request (IN_PROGRESS) this GET is used to retrieve status until COMPLETED. At which time, the optimizer will issue a DELETE to acknowledge receipt.\nThe Topology Service implementation may delete the cache when returning completed. The optimizer will treat subsequent not found on delete as normal.",
"operationId" : "getTopologyRequest",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "apiVersion",
"in" : "path",
"description" : "v1",
"required" : true,
"type" : "string",
"default" : "v1"
}, {
"name" : "id",
"in" : "path",
"description" : "Request Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK",
"schema" : {
"$ref" : "#/definitions/Topology Response"
}
},
"404" : {
"description" : "Not Found",
"schema" : {
"$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
"description" : "Unexpected Runtime error"
}
}
},
"delete" : {
"tags" : [ "Topology Interface" ],
"summary" : "Acknowledge Topology Response",
"description" : "API to acknowledge COMPLETED toplogy request.",
"operationId" : "deleteTopologyRequest",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "apiVersion",
"in" : "path",
"description" : "v1",
"required" : true,
"type" : "string",
"default" : "v1"
}, {
"name" : "id",
"in" : "path",
"description" : "Request Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK",
"schema" : {
"$ref" : "#/definitions/Topology Response"
}
},
"404" : {
"description" : "Not Found",
"schema" : {
"$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
"description" : "Unexpected Runtime error"
}
}
}
},
"/{apiVersion}/health" : {
"get" : {
"tags" : [ "Administration" ],
"summary" : "",
"description" : "Returns health status of server.",
"operationId" : "healthCheck",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "apiVersion",
"in" : "path",
"description" : "v1",
"required" : true,
"type" : "string",
"default" : "v1"
}, {
"name" : "checkInterfaces",
"in" : "query",
"description" : "Check Interfaces",
"required" : false,
"type" : "boolean",
"default" : true
} ],
"responses" : {
"200" : {
"description" : "OK",
"schema" : {
"$ref" : "#/definitions/HealthCheckMessage"
}
},
"400" : {
"description" : "Not healthy",
"schema" : {
"$ref" : "#/definitions/HealthCheckMessage"
}
}
}
}
}
},
"definitions" : {
"CmsoRequestError" : {
"type" : "object",
"properties" : {
"requestError" : {
"$ref" : "#/definitions/RequestError"
}
}
},
"Element Critera" : {
"type" : "object",
"properties" : {
"elementId" : {
"type" : "string",
"description" : "Element id unique to the request."
},
"elementData" : {
"type" : "array",
"description" : "Implementation specific element data.",
"items" : {
"$ref" : "#/definitions/Name Value Data"
}
}
},
"description" : "Element criteria for retrieving topology."
},
"Element Location" : {
"type" : "object",
"properties" : {
"lat" : {
"type" : "number",
"format" : "float",
"description" : "Geographic latitude of element."
},
"lon" : {
"type" : "number",
"format" : "float",
"description" : "Geographic longitude of element."
},
"timezone" : {
"type" : "string",
"description" : "Timezone."
}
},
"description" : "Location information necessary to determine timezone. lat/lon and/or timezone must be provided"
},
"HealthCheckComponent" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"healthy" : {
"type" : "boolean"
}
}
},
"HealthCheckMessage" : {
"type" : "object",
"properties" : {
"healthy" : {
"type" : "boolean"
},
"buildInfo" : {
"type" : "string"
},
"currentTime" : {
"type" : "string"
},
"hostname" : {
"type" : "string"
},
"components" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HealthCheckComponent"
}
}
}
},
"Name Value Data" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name."
},
"value" : {
"type" : "object",
"description" : "Value."
}
},
"description" : "Instance of a name/value"
},
"RequestError" : {
"type" : "object",
"properties" : {
"messageId" : {
"type" : "string"
},
"text" : {
"type" : "string"
},
"variables" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"Supported Policy Information" : {
"type" : "object",
"properties" : {
"policyName" : {
"type" : "string",
"description" : "Policy name"
},
"policyDescription" : {
"type" : "string",
"description" : "Policy description"
},
"policyModifiers" : {
"type" : "array",
"description" : "Named values to modify/override policy attributes.",
"items" : {
"$ref" : "#/definitions/Name Value Data"
}
}
},
"description" : "Policy Information returned from get policies API."
},
"Topology Constraint ELements" : {
"type" : "object",
"properties" : {
"elementId" : {
"type" : "string",
"description" : "Element identifier"
},
"constraintType" : {
"type" : "string",
"description" : "Type of constraint."
},
"constraintTypeMinimum" : {
"type" : "integer",
"format" : "int32",
"description" : "If more than one instance of constraintType, minimum number of available instances required. Useful for identifying availableBackup elements, service paths."
},
"optimizerAvailabilityMatrixName" : {
"type" : "string",
"description" : "Availability matrix name. Availability matrix will not be passed to optimizer engine. Generally useful for global concurrency type constraints."
},
"availabilityMatrixScope" : {
"type" : "string",
"description" : "Availability matrix scope global or scoped per elementId.",
"enum" : [ "NONE", "GLOBAL", "ELEMENT" ]
},
"elementAvailabilityAggreagation" : {
"type" : "boolean",
"description" : "Availability matrix is aggregated into element availability marrix."
},
"elements" : {
"type" : "array",
"description" : "Elements ",
"items" : {
"type" : "string"
}
}
},
"description" : "Constraining Element Information returned from TopologyRequuest."
},
"Topology Element" : {
"type" : "object",
"properties" : {
"elementId" : {
"type" : "string",
"description" : "Element identifier"
},
"elementLocation" : {
"description" : "Location information for the element.",
"$ref" : "#/definitions/Element Location"
},
"requiredElements" : {
"type" : "array",
"description" : "List of related elements required to be available to execute the chenge.",
"items" : {
"type" : "string"
}
},
"constraintElements" : {
"type" : "array",
"description" : "Lists of related elements that must be available to avoid network outage while executing the change. Each set constraint elements",
"items" : {
"$ref" : "#/definitions/Topology Constraint ELements"
}
},
"elementData" : {
"type" : "array",
"description" : "Implementation specific element data.",
"items" : {
"$ref" : "#/definitions/Name Value Data"
}
}
},
"description" : "Element Information returned from TopologyRequuest."
},
"Topology Related Element" : {
"type" : "object",
"properties" : {
"elementId" : {
"type" : "string",
"description" : "Element identifier"
},
"elementLocation" : {
"description" : "Location information for the element.",
"$ref" : "#/definitions/Element Location"
},
"elementData" : {
"type" : "array",
"description" : "Implementation specific element data.",
"items" : {
"$ref" : "#/definitions/Name Value Data"
}
},
"relatedElements" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "Element Information returned from TopologyRequuest."
},
"Topology Request" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string",
"description" : "Unique Id of the request"
},
"commonData" : {
"type" : "array",
"description" : "Implementation specific name value pairs.",
"items" : {
"$ref" : "#/definitions/Name Value Data"
}
},
"elements" : {
"type" : "array",
"description" : "List of the elements for which topology information is requested.",
"items" : {
"$ref" : "#/definitions/Element Critera"
}
},
"policies" : {
"type" : "array",
"description" : "List of the policies to control topology retrieve.",
"items" : {
"$ref" : "#/definitions/Supported Policy Information"
}
}
},
"description" : "Request to retrieve topology information for the provided elements."
},
"Topology Response" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string",
"description" : "Unique Id of the request"
},
"elements" : {
"type" : "array",
"description" : "List of elements for for which topology has been requested.",
"items" : {
"$ref" : "#/definitions/Topology Element"
}
},
"referencedElements" : {
"type" : "array",
"description" : "List of referenced elements representing the topology that has been requested.",
"items" : {
"$ref" : "#/definitions/Topology Related Element"
}
},
"status" : {
"type" : "string",
"description" : "Status of asynchronous request. COMPLETED is returned on initial synchonous request. If IN_PROGRESS is returned, the optimizer will enter asynchronous polling mode.",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"errorMessage" : {
"type" : "string",
"description" : "FAILED request error message."
},
"pollingSeconds" : {
"type" : "integer",
"format" : "int32",
"description" : "If request is asynchronous (IN_PROGRESS), suggested interval to the next poll."
}
},
"description" : "Response to topology query for the requested elements."
}
}
}
|
