@itentialopensource/adapter-nokia_altiplano 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/BROKER.md +6 -2
  2. package/CALLS.md +144 -0
  3. package/CHANGELOG.md +24 -8
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/adapter.js +159 -330
  8. package/adapterBase.js +555 -852
  9. package/changelogs/changelog.md +72 -0
  10. package/metadata.json +47 -0
  11. package/package.json +25 -25
  12. package/pronghorn.json +485 -146
  13. package/propertiesSchema.json +478 -37
  14. package/refs?service=git-upload-pack +0 -0
  15. package/report/adapter-openapi.json +1546 -0
  16. package/report/adapter-openapi.yaml +1392 -0
  17. package/report/adapterInfo.json +10 -0
  18. package/report/updateReport1652620670443.json +120 -0
  19. package/report/updateReport1691507619656.json +120 -0
  20. package/report/updateReport1692202622632.json +120 -0
  21. package/report/updateReport1694462147618.json +120 -0
  22. package/report/updateReport1698421046815.json +120 -0
  23. package/sampleProperties.json +77 -9
  24. package/test/integration/adapterTestBasicGet.js +3 -5
  25. package/test/integration/adapterTestConnectivity.js +91 -42
  26. package/test/integration/adapterTestIntegration.js +154 -110
  27. package/test/unit/adapterBaseTestUnit.js +388 -313
  28. package/test/unit/adapterTestUnit.js +366 -224
  29. package/utils/adapterInfo.js +1 -1
  30. package/utils/addAuth.js +1 -1
  31. package/utils/artifactize.js +1 -1
  32. package/utils/checkMigrate.js +1 -1
  33. package/utils/entitiesToDB.js +12 -57
  34. package/utils/findPath.js +1 -1
  35. package/utils/methodDocumentor.js +273 -0
  36. package/utils/modify.js +13 -15
  37. package/utils/packModificationScript.js +1 -1
  38. package/utils/pre-commit.sh +2 -0
  39. package/utils/taskMover.js +309 -0
  40. package/utils/tbScript.js +123 -53
  41. package/utils/tbUtils.js +84 -59
  42. package/utils/testRunner.js +17 -17
  43. package/utils/troubleshootingAdapter.js +9 -6
  44. package/workflows/README.md +0 -3
package/report/adapter-openapi.json ADDED
@@ -0,0 +1,1546 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "Nokia Altiplano",
5
+ "contact": {},
6
+ "version": "1.0"
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "http://nokiaaltiplano.com/{base-url}/rest",
11
+ "variables": {
12
+ "base-url": {
13
+ "default": "DefaultParameterValue"
14
+ }
15
+ }
16
+ }
17
+ ],
18
+ "paths": {
19
+ "/auth/login": {
20
+ "post": {
21
+ "tags": [
22
+ "Intent"
23
+ ],
24
+ "summary": "GetAccessToken",
25
+ "description": "Get Access Token and Refresh Token by Login method before executing any other RESTCONF request.",
26
+ "operationId": "GetAccessToken",
27
+ "parameters": [],
28
+ "responses": {
29
+ "200": {
30
+ "description": "",
31
+ "headers": {}
32
+ }
33
+ },
34
+ "deprecated": false
35
+ }
36
+ },
37
+ "/restconf/data/ibn:ibn/{intent}/dependents-summary": {
38
+ "post": {
39
+ "tags": [
40
+ "Intent"
41
+ ],
42
+ "summary": "Dependents-summary for device",
43
+ "description": "Dependents-summary for device",
44
+ "operationId": "dependentsSummaryForDevice",
45
+ "parameters": [
46
+ {
47
+ "name": "intent",
48
+ "in": "path",
49
+ "description": "the intent",
50
+ "required": true,
51
+ "schema": {
52
+ "type": "string",
53
+ "example": "intent=INES-172-31-30-140,device-fx"
54
+ }
55
+ }
56
+ ],
57
+ "responses": {
58
+ "200": {
59
+ "description": "",
60
+ "headers": {}
61
+ }
62
+ },
63
+ "deprecated": false
64
+ }
65
+ },
66
+ "/restconf/operations/ibn:search-intents": {
67
+ "post": {
68
+ "tags": [
69
+ "Intent"
70
+ ],
71
+ "summary": "Get uplink-connection configuration",
72
+ "description": "This request sample is used to search intents.\r\nThis request contains all the filter elements, elements which should not be part of search filter should be removed before sending the request.",
73
+ "operationId": "getuplinkConnectionConfiguration",
74
+ "parameters": [],
75
+ "requestBody": {
76
+ "description": "",
77
+ "content": {
78
+ "application/json": {
79
+ "schema": {
80
+ "$ref": "#/components/schemas/Getuplink-connectionconfigurationRequest"
81
+ },
82
+ "example": {
83
+ "ibn:input": {
84
+ "filter": {
85
+ "intent-type-list": {
86
+ "intent-type": "uplink-connection"
87
+ },
88
+ "target": "INES-172-31-30-140",
89
+ "predicate": "MATCHES",
90
+ "required-network-state": "active",
91
+ "order-by": "asc.intent-type",
92
+ "config-required": "true"
93
+ },
94
+ "page-number": "0",
95
+ "page-size": "10"
96
+ }
97
+ }
98
+ }
99
+ },
100
+ "required": true
101
+ },
102
+ "responses": {
103
+ "200": {
104
+ "description": "",
105
+ "headers": {}
106
+ }
107
+ },
108
+ "deprecated": false
109
+ }
110
+ },
111
+ "/restconf/data/ibn:ibn/{intent},fiber/dependents-summary": {
112
+ "post": {
113
+ "tags": [
114
+ "Intent"
115
+ ],
116
+ "summary": "Dependents summary fiber",
117
+ "description": "Dependents summary fiber",
118
+ "operationId": "dependentsSummaryFiber",
119
+ "parameters": [
120
+ {
121
+ "name": "intent",
122
+ "in": "path",
123
+ "description": "the intent",
124
+ "required": true,
125
+ "schema": {
126
+ "type": "string",
127
+ "example": "intent=INES-1-1-4-3"
128
+ }
129
+ }
130
+ ],
131
+ "responses": {
132
+ "200": {
133
+ "description": "",
134
+ "headers": {}
135
+ }
136
+ },
137
+ "deprecated": false
138
+ }
139
+ },
140
+ "/restconf/data/ibn:ibn": {
141
+ "post": {
142
+ "tags": [
143
+ "Intent"
144
+ ],
145
+ "summary": "Create ont",
146
+ "description": "Create ont",
147
+ "operationId": "createOnt",
148
+ "parameters": [],
149
+ "requestBody": {
150
+ "description": "",
151
+ "content": {
152
+ "application/json": {
153
+ "schema": {
154
+ "$ref": "#/components/schemas/CreateontRequest"
155
+ },
156
+ "example": {
157
+ "ibn:intent": {
158
+ "target": "INES-1-1-4-3-a",
159
+ "intent-type": "ont",
160
+ "intent-type-version": "4",
161
+ "required-network-state": "active",
162
+ "intent-specific-data": {
163
+ "ont:ont": {
164
+ "ont-type": "G-010G-Q",
165
+ "fiber-name": "INES-1-1-4-3",
166
+ "expected-serial-number": "ALCLF846403A",
167
+ "onu-service-profile": "default",
168
+ "uni-service-configuration": {
169
+ "uni-id": "LAN1",
170
+ "service-profile": "default"
171
+ }
172
+ }
173
+ }
174
+ }
175
+ }
176
+ }
177
+ },
178
+ "required": true
179
+ },
180
+ "responses": {
181
+ "200": {
182
+ "description": "",
183
+ "headers": {}
184
+ }
185
+ },
186
+ "deprecated": false
187
+ }
188
+ },
189
+ "/restconf/data/ibn:ibn/{intent},ont": {
190
+ "get": {
191
+ "tags": [
192
+ "Intent"
193
+ ],
194
+ "summary": "GET ont",
195
+ "description": "GET ont",
196
+ "operationId": "getOnt",
197
+ "parameters": [
198
+ {
199
+ "name": "intent",
200
+ "in": "path",
201
+ "description": "the intent",
202
+ "required": true,
203
+ "schema": {
204
+ "type": "string",
205
+ "example": "intent=INES-1-1-4-3"
206
+ }
207
+ }
208
+ ],
209
+ "responses": {
210
+ "200": {
211
+ "description": "",
212
+ "headers": {}
213
+ }
214
+ },
215
+ "deprecated": false
216
+ },
217
+ "patch": {
218
+ "tags": [
219
+ "Intent"
220
+ ],
221
+ "summary": "Lock ont",
222
+ "description": "This request sample is used to modify intent state.\r\nThe value of required-network-state can be active or suspend or delete",
223
+ "operationId": "lockOnt",
224
+ "parameters": [
225
+ {
226
+ "name": "intent",
227
+ "in": "path",
228
+ "description": "the intent",
229
+ "required": true,
230
+ "schema": {
231
+ "type": "string",
232
+ "example": "intent=INES-1-1-4-3"
233
+ }
234
+ }
235
+ ],
236
+ "requestBody": {
237
+ "description": "",
238
+ "content": {
239
+ "application/json": {
240
+ "schema": {
241
+ "$ref": "#/components/schemas/LockontRequest"
242
+ },
243
+ "example": {
244
+ "ibn:intent": {
245
+ "intent-type-version": 4,
246
+ "required-network-state": "suspend"
247
+ }
248
+ }
249
+ }
250
+ },
251
+ "required": true
252
+ },
253
+ "responses": {
254
+ "200": {
255
+ "description": "",
256
+ "headers": {}
257
+ }
258
+ },
259
+ "deprecated": false
260
+ },
261
+ "delete": {
262
+ "tags": [
263
+ "Intent"
264
+ ],
265
+ "summary": "Delete ont",
266
+ "description": "This request sample is used to delete an intent.",
267
+ "operationId": "deleteOnt",
268
+ "parameters": [
269
+ {
270
+ "name": "intent",
271
+ "in": "path",
272
+ "description": "the intent",
273
+ "required": true,
274
+ "schema": {
275
+ "type": "string",
276
+ "example": "intent=INES-1-1-4-3"
277
+ }
278
+ }
279
+ ],
280
+ "responses": {
281
+ "200": {
282
+ "description": "",
283
+ "headers": {}
284
+ }
285
+ },
286
+ "deprecated": false
287
+ }
288
+ },
289
+ "/restconf/data/ibn:ibn/{intent},ont/synchronize": {
290
+ "post": {
291
+ "tags": [
292
+ "Intent"
293
+ ],
294
+ "summary": "Synchronize ont",
295
+ "description": "Synchronize ont",
296
+ "operationId": "synchronizeOnt",
297
+ "parameters": [
298
+ {
299
+ "name": "intent",
300
+ "in": "path",
301
+ "description": "the intent",
302
+ "required": true,
303
+ "schema": {
304
+ "type": "string",
305
+ "example": "intent=INES-1-1-4-3"
306
+ }
307
+ }
308
+ ],
309
+ "responses": {
310
+ "200": {
311
+ "description": "",
312
+ "headers": {}
313
+ }
314
+ },
315
+ "deprecated": false
316
+ }
317
+ },
318
+ "/restconf/data/ibn:ibn/{intent},ont/audit": {
319
+ "post": {
320
+ "tags": [
321
+ "Intent"
322
+ ],
323
+ "summary": "Audit ont",
324
+ "description": "Audit ont",
325
+ "operationId": "auditOnt",
326
+ "parameters": [
327
+ {
328
+ "name": "intent",
329
+ "in": "path",
330
+ "description": "the intent",
331
+ "required": true,
332
+ "schema": {
333
+ "type": "string",
334
+ "example": "intent=INES-1-1-4-3"
335
+ }
336
+ }
337
+ ],
338
+ "responses": {
339
+ "200": {
340
+ "description": "",
341
+ "headers": {}
342
+ }
343
+ },
344
+ "deprecated": false
345
+ }
346
+ },
347
+ "/restconf/data/ibn:ibn/{intent},l2-user/synchronize": {
348
+ "post": {
349
+ "tags": [
350
+ "Intent"
351
+ ],
352
+ "summary": "Synchronize l2-user",
353
+ "description": "Synchronize l2-user",
354
+ "operationId": "synchronizel2User",
355
+ "parameters": [
356
+ {
357
+ "name": "intent",
358
+ "in": "path",
359
+ "description": "the intent",
360
+ "required": true,
361
+ "schema": {
362
+ "type": "string",
363
+ "example": "intent=INES-1-1-4-3"
364
+ }
365
+ }
366
+ ],
367
+ "responses": {
368
+ "200": {
369
+ "description": "",
370
+ "headers": {}
371
+ }
372
+ },
373
+ "deprecated": false
374
+ }
375
+ },
376
+ "/restconf/data/ibn:ibn/{intent},l2-user": {
377
+ "get": {
378
+ "tags": [
379
+ "Intent"
380
+ ],
381
+ "summary": "GET l2-user",
382
+ "description": "GET l2-user",
383
+ "operationId": "getl2User",
384
+ "parameters": [
385
+ {
386
+ "name": "intent",
387
+ "in": "path",
388
+ "description": "the intent",
389
+ "required": true,
390
+ "schema": {
391
+ "type": "string",
392
+ "example": "intent=INES-1-1-4-3"
393
+ }
394
+ }
395
+ ],
396
+ "responses": {
397
+ "200": {
398
+ "description": "",
399
+ "headers": {}
400
+ }
401
+ },
402
+ "deprecated": false
403
+ },
404
+ "patch": {
405
+ "tags": [
406
+ "Intent"
407
+ ],
408
+ "summary": "Modify l2-user",
409
+ "description": "This request sample is used to modify intent state.\r\nThe value of required-network-state can be active or suspend or delete",
410
+ "operationId": "modifyl2User",
411
+ "parameters": [
412
+ {
413
+ "name": "intent",
414
+ "in": "path",
415
+ "description": "the intent",
416
+ "required": true,
417
+ "schema": {
418
+ "type": "string",
419
+ "example": "intent=INES-1-1-4-3"
420
+ }
421
+ }
422
+ ],
423
+ "requestBody": {
424
+ "description": "",
425
+ "content": {
426
+ "application/json": {
427
+ "schema": {
428
+ "$ref": "#/components/schemas/Modifyl2-userRequest"
429
+ },
430
+ "example": {
431
+ "ibn:intent": {
432
+ "intent-type": "l2-user",
433
+ "intent-type-version": 4,
434
+ "intent-specific-data": {
435
+ "l2-user:l2-user": {
436
+ "service-profile": "HSI-100M-10M-16MAC"
437
+ }
438
+ }
439
+ }
440
+ }
441
+ }
442
+ },
443
+ "required": true
444
+ },
445
+ "responses": {
446
+ "200": {
447
+ "description": "",
448
+ "headers": {}
449
+ }
450
+ },
451
+ "deprecated": false
452
+ },
453
+ "delete": {
454
+ "tags": [
455
+ "Intent"
456
+ ],
457
+ "summary": "Delete l2-user",
458
+ "description": "This request sample is used to delete an intent.",
459
+ "operationId": "deletel2User",
460
+ "parameters": [
461
+ {
462
+ "name": "intent",
463
+ "in": "path",
464
+ "description": "the intent",
465
+ "required": true,
466
+ "schema": {
467
+ "type": "string",
468
+ "example": "intent=INES-1-1-4-3"
469
+ }
470
+ }
471
+ ],
472
+ "responses": {
473
+ "200": {
474
+ "description": "",
475
+ "headers": {}
476
+ }
477
+ },
478
+ "deprecated": false
479
+ }
480
+ },
481
+ "/restconf/data/ibn:ibn/{intent},l2-user/audit": {
482
+ "post": {
483
+ "tags": [
484
+ "Intent"
485
+ ],
486
+ "summary": "Audit l2-user",
487
+ "description": "Audit l2-user",
488
+ "operationId": "auditl2User",
489
+ "parameters": [
490
+ {
491
+ "name": "intent",
492
+ "in": "path",
493
+ "description": "the intent",
494
+ "required": true,
495
+ "schema": {
496
+ "type": "string",
497
+ "example": "intent=INES-1-1-4-3"
498
+ }
499
+ }
500
+ ],
501
+ "responses": {
502
+ "200": {
503
+ "description": "",
504
+ "headers": {}
505
+ }
506
+ },
507
+ "deprecated": false
508
+ }
509
+ }
510
+ },
511
+ "components": {
512
+ "schemas": {
513
+ "Getuplink-connectionconfigurationRequest": {
514
+ "title": "Getuplink-connectionconfigurationRequest",
515
+ "required": [
516
+ "ibn:input"
517
+ ],
518
+ "type": "object",
519
+ "properties": {
520
+ "ibn:input": {
521
+ "$ref": "#/components/schemas/IbnInput"
522
+ }
523
+ },
524
+ "example": {
525
+ "ibn:input": {
526
+ "filter": {
527
+ "intent-type-list": {
528
+ "intent-type": "uplink-connection"
529
+ },
530
+ "target": "INES-172-31-30-140",
531
+ "predicate": "MATCHES",
532
+ "required-network-state": "active",
533
+ "order-by": "asc.intent-type",
534
+ "config-required": "true"
535
+ },
536
+ "page-number": "0",
537
+ "page-size": "10"
538
+ }
539
+ }
540
+ },
541
+ "IbnInput": {
542
+ "title": "IbnInput",
543
+ "required": [
544
+ "filter",
545
+ "page-number",
546
+ "page-size"
547
+ ],
548
+ "type": "object",
549
+ "properties": {
550
+ "filter": {
551
+ "$ref": "#/components/schemas/Filter"
552
+ },
553
+ "page-number": {
554
+ "type": "string"
555
+ },
556
+ "page-size": {
557
+ "type": "string"
558
+ }
559
+ },
560
+ "example": {
561
+ "filter": {
562
+ "intent-type-list": {
563
+ "intent-type": "uplink-connection"
564
+ },
565
+ "target": "INES-172-31-30-140",
566
+ "predicate": "MATCHES",
567
+ "required-network-state": "active",
568
+ "order-by": "asc.intent-type",
569
+ "config-required": "true"
570
+ },
571
+ "page-number": "0",
572
+ "page-size": "10"
573
+ }
574
+ },
575
+ "Filter": {
576
+ "title": "Filter",
577
+ "required": [
578
+ "intent-type-list",
579
+ "target",
580
+ "predicate",
581
+ "required-network-state",
582
+ "order-by",
583
+ "config-required"
584
+ ],
585
+ "type": "object",
586
+ "properties": {
587
+ "intent-type-list": {
588
+ "$ref": "#/components/schemas/IntentTypeList"
589
+ },
590
+ "target": {
591
+ "type": "string"
592
+ },
593
+ "predicate": {
594
+ "type": "string"
595
+ },
596
+ "required-network-state": {
597
+ "type": "string"
598
+ },
599
+ "order-by": {
600
+ "type": "string"
601
+ },
602
+ "config-required": {
603
+ "type": "string"
604
+ }
605
+ },
606
+ "example": {
607
+ "intent-type-list": {
608
+ "intent-type": "uplink-connection"
609
+ },
610
+ "target": "INES-172-31-30-140",
611
+ "predicate": "MATCHES",
612
+ "required-network-state": "active",
613
+ "order-by": "asc.intent-type",
614
+ "config-required": "true"
615
+ }
616
+ },
617
+ "IntentTypeList": {
618
+ "title": "IntentTypeList",
619
+ "required": [
620
+ "intent-type"
621
+ ],
622
+ "type": "object",
623
+ "properties": {
624
+ "intent-type": {
625
+ "type": "string"
626
+ }
627
+ },
628
+ "example": {
629
+ "intent-type": "uplink-connection"
630
+ }
631
+ },
632
+ "Getl2-infraconfigurationRequest": {
633
+ "title": "Getl2-infraconfigurationRequest",
634
+ "required": [
635
+ "ibn:input"
636
+ ],
637
+ "type": "object",
638
+ "properties": {
639
+ "ibn:input": {
640
+ "$ref": "#/components/schemas/IbnInput"
641
+ }
642
+ },
643
+ "example": {
644
+ "ibn:input": {
645
+ "filter": {
646
+ "intent-type-list": {
647
+ "intent-type": "l2-infra"
648
+ },
649
+ "target": "INES-172-31-30-140#HSI_Bronze",
650
+ "predicate": "MATCHES",
651
+ "required-network-state": "active",
652
+ "order-by": "asc.intent-type",
653
+ "config-required": "true"
654
+ },
655
+ "page-number": "0",
656
+ "page-size": "10"
657
+ }
658
+ }
659
+ },
660
+ "GetfiberconfigurationonefiberinstanceRequest": {
661
+ "title": "GetfiberconfigurationonefiberinstanceRequest",
662
+ "required": [
663
+ "ibn:input"
664
+ ],
665
+ "type": "object",
666
+ "properties": {
667
+ "ibn:input": {
668
+ "$ref": "#/components/schemas/IbnInput"
669
+ }
670
+ },
671
+ "example": {
672
+ "ibn:input": {
673
+ "filter": {
674
+ "intent-type-list": {
675
+ "intent-type": "fiber"
676
+ },
677
+ "target": "INES-1-1-4-3",
678
+ "predicate": "MATCHES",
679
+ "required-network-state": "active",
680
+ "order-by": "asc.intent-type",
681
+ "config-required": "true"
682
+ },
683
+ "page-number": "0",
684
+ "page-size": "10"
685
+ }
686
+ }
687
+ },
688
+ "GetfiberconfigurationallfiberinstancesRequest": {
689
+ "title": "GetfiberconfigurationallfiberinstancesRequest",
690
+ "required": [
691
+ "ibn:input"
692
+ ],
693
+ "type": "object",
694
+ "properties": {
695
+ "ibn:input": {
696
+ "$ref": "#/components/schemas/IbnInput3"
697
+ }
698
+ },
699
+ "example": {
700
+ "ibn:input": {
701
+ "filter": {
702
+ "intent-type-list": {
703
+ "intent-type": "fiber"
704
+ }
705
+ },
706
+ "page-number": "0",
707
+ "page-size": "10"
708
+ }
709
+ }
710
+ },
711
+ "IbnInput3": {
712
+ "title": "IbnInput3",
713
+ "required": [
714
+ "filter",
715
+ "page-number",
716
+ "page-size"
717
+ ],
718
+ "type": "object",
719
+ "properties": {
720
+ "filter": {
721
+ "$ref": "#/components/schemas/Filter3"
722
+ },
723
+ "page-number": {
724
+ "type": "string"
725
+ },
726
+ "page-size": {
727
+ "type": "string"
728
+ }
729
+ },
730
+ "example": {
731
+ "filter": {
732
+ "intent-type-list": {
733
+ "intent-type": "fiber"
734
+ }
735
+ },
736
+ "page-number": "0",
737
+ "page-size": "10"
738
+ }
739
+ },
740
+ "Filter3": {
741
+ "title": "Filter3",
742
+ "required": [
743
+ "intent-type-list"
744
+ ],
745
+ "type": "object",
746
+ "properties": {
747
+ "intent-type-list": {
748
+ "$ref": "#/components/schemas/IntentTypeList"
749
+ }
750
+ },
751
+ "example": {
752
+ "intent-type-list": {
753
+ "intent-type": "fiber"
754
+ }
755
+ }
756
+ },
757
+ "CreateontRequest": {
758
+ "title": "CreateontRequest",
759
+ "required": [
760
+ "ibn:intent"
761
+ ],
762
+ "type": "object",
763
+ "properties": {
764
+ "ibn:intent": {
765
+ "$ref": "#/components/schemas/IbnIntent"
766
+ }
767
+ },
768
+ "example": {
769
+ "ibn:intent": {
770
+ "target": "INES-1-1-4-3-a",
771
+ "intent-type": "ont",
772
+ "intent-type-version": "4",
773
+ "required-network-state": "active",
774
+ "intent-specific-data": {
775
+ "ont:ont": {
776
+ "ont-type": "G-010G-Q",
777
+ "fiber-name": "INES-1-1-4-3",
778
+ "expected-serial-number": "ALCLF846403A",
779
+ "onu-service-profile": "default",
780
+ "uni-service-configuration": {
781
+ "uni-id": "LAN1",
782
+ "service-profile": "default"
783
+ }
784
+ }
785
+ }
786
+ }
787
+ }
788
+ },
789
+ "IbnIntent": {
790
+ "title": "IbnIntent",
791
+ "required": [
792
+ "target",
793
+ "intent-type",
794
+ "intent-type-version",
795
+ "required-network-state",
796
+ "intent-specific-data"
797
+ ],
798
+ "type": "object",
799
+ "properties": {
800
+ "target": {
801
+ "type": "string"
802
+ },
803
+ "intent-type": {
804
+ "type": "string"
805
+ },
806
+ "intent-type-version": {
807
+ "type": "string"
808
+ },
809
+ "required-network-state": {
810
+ "type": "string"
811
+ },
812
+ "intent-specific-data": {
813
+ "$ref": "#/components/schemas/IntentSpecificData"
814
+ }
815
+ },
816
+ "example": {
817
+ "target": "INES-1-1-4-3-a",
818
+ "intent-type": "ont",
819
+ "intent-type-version": "4",
820
+ "required-network-state": "active",
821
+ "intent-specific-data": {
822
+ "ont:ont": {
823
+ "ont-type": "G-010G-Q",
824
+ "fiber-name": "INES-1-1-4-3",
825
+ "expected-serial-number": "ALCLF846403A",
826
+ "onu-service-profile": "default",
827
+ "uni-service-configuration": {
828
+ "uni-id": "LAN1",
829
+ "service-profile": "default"
830
+ }
831
+ }
832
+ }
833
+ }
834
+ },
835
+ "IntentSpecificData": {
836
+ "title": "IntentSpecificData",
837
+ "required": [
838
+ "ont:ont"
839
+ ],
840
+ "type": "object",
841
+ "properties": {
842
+ "ont:ont": {
843
+ "$ref": "#/components/schemas/OntOnt"
844
+ }
845
+ },
846
+ "example": {
847
+ "ont:ont": {
848
+ "ont-type": "G-010G-Q",
849
+ "fiber-name": "INES-1-1-4-3",
850
+ "expected-serial-number": "ALCLF846403A",
851
+ "onu-service-profile": "default",
852
+ "uni-service-configuration": {
853
+ "uni-id": "LAN1",
854
+ "service-profile": "default"
855
+ }
856
+ }
857
+ }
858
+ },
859
+ "OntOnt": {
860
+ "title": "OntOnt",
861
+ "required": [
862
+ "ont-type",
863
+ "fiber-name",
864
+ "expected-serial-number",
865
+ "onu-service-profile",
866
+ "uni-service-configuration"
867
+ ],
868
+ "type": "object",
869
+ "properties": {
870
+ "ont-type": {
871
+ "type": "string"
872
+ },
873
+ "fiber-name": {
874
+ "type": "string"
875
+ },
876
+ "expected-serial-number": {
877
+ "type": "string"
878
+ },
879
+ "onu-service-profile": {
880
+ "type": "string"
881
+ },
882
+ "uni-service-configuration": {
883
+ "$ref": "#/components/schemas/UniServiceConfiguration"
884
+ }
885
+ },
886
+ "example": {
887
+ "ont-type": "G-010G-Q",
888
+ "fiber-name": "INES-1-1-4-3",
889
+ "expected-serial-number": "ALCLF846403A",
890
+ "onu-service-profile": "default",
891
+ "uni-service-configuration": {
892
+ "uni-id": "LAN1",
893
+ "service-profile": "default"
894
+ }
895
+ }
896
+ },
897
+ "UniServiceConfiguration": {
898
+ "title": "UniServiceConfiguration",
899
+ "required": [
900
+ "uni-id",
901
+ "service-profile"
902
+ ],
903
+ "type": "object",
904
+ "properties": {
905
+ "uni-id": {
906
+ "type": "string"
907
+ },
908
+ "service-profile": {
909
+ "type": "string"
910
+ }
911
+ },
912
+ "example": {
913
+ "uni-id": "LAN1",
914
+ "service-profile": "default"
915
+ }
916
+ },
917
+ "GetontconfigurationRequest": {
918
+ "title": "GetontconfigurationRequest",
919
+ "required": [
920
+ "ibn:input"
921
+ ],
922
+ "type": "object",
923
+ "properties": {
924
+ "ibn:input": {
925
+ "$ref": "#/components/schemas/IbnInput4"
926
+ }
927
+ },
928
+ "example": {
929
+ "ibn:input": {
930
+ "filter": {
931
+ "intent-type-list": {
932
+ "intent-type": "ont"
933
+ },
934
+ "target": "INES-1-1-4-3-a",
935
+ "predicate": "MATCHES",
936
+ "order-by": "asc.intent-type",
937
+ "config-required": "true"
938
+ },
939
+ "page-number": "0",
940
+ "page-size": "10"
941
+ }
942
+ }
943
+ },
944
+ "IbnInput4": {
945
+ "title": "IbnInput4",
946
+ "required": [
947
+ "filter",
948
+ "page-number",
949
+ "page-size"
950
+ ],
951
+ "type": "object",
952
+ "properties": {
953
+ "filter": {
954
+ "$ref": "#/components/schemas/Filter4"
955
+ },
956
+ "page-number": {
957
+ "type": "string"
958
+ },
959
+ "page-size": {
960
+ "type": "string"
961
+ }
962
+ },
963
+ "example": {
964
+ "filter": {
965
+ "intent-type-list": {
966
+ "intent-type": "ont"
967
+ },
968
+ "target": "INES-1-1-4-3-a",
969
+ "predicate": "MATCHES",
970
+ "order-by": "asc.intent-type",
971
+ "config-required": "true"
972
+ },
973
+ "page-number": "0",
974
+ "page-size": "10"
975
+ }
976
+ },
977
+ "Filter4": {
978
+ "title": "Filter4",
979
+ "required": [
980
+ "intent-type-list",
981
+ "target",
982
+ "predicate",
983
+ "order-by",
984
+ "config-required"
985
+ ],
986
+ "type": "object",
987
+ "properties": {
988
+ "intent-type-list": {
989
+ "$ref": "#/components/schemas/IntentTypeList"
990
+ },
991
+ "target": {
992
+ "type": "string"
993
+ },
994
+ "predicate": {
995
+ "type": "string"
996
+ },
997
+ "order-by": {
998
+ "type": "string"
999
+ },
1000
+ "config-required": {
1001
+ "type": "string"
1002
+ }
1003
+ },
1004
+ "example": {
1005
+ "intent-type-list": {
1006
+ "intent-type": "ont"
1007
+ },
1008
+ "target": "INES-1-1-4-3-a",
1009
+ "predicate": "MATCHES",
1010
+ "order-by": "asc.intent-type",
1011
+ "config-required": "true"
1012
+ }
1013
+ },
1014
+ "GetallontsthatcontainstringRequest": {
1015
+ "title": "GetallontsthatcontainstringRequest",
1016
+ "required": [
1017
+ "ibn:input"
1018
+ ],
1019
+ "type": "object",
1020
+ "properties": {
1021
+ "ibn:input": {
1022
+ "$ref": "#/components/schemas/IbnInput"
1023
+ }
1024
+ },
1025
+ "example": {
1026
+ "ibn:input": {
1027
+ "filter": {
1028
+ "intent-type-list": {
1029
+ "intent-type": "ont"
1030
+ },
1031
+ "target": "INES-1-1-4-3",
1032
+ "predicate": "CONTAINS",
1033
+ "required-network-state": "active",
1034
+ "order-by": "asc.intent-type",
1035
+ "config-required": "true"
1036
+ },
1037
+ "page-number": "0",
1038
+ "page-size": "10"
1039
+ }
1040
+ }
1041
+ },
1042
+ "SearchESforanontRequest": {
1043
+ "title": "SearchESforanontRequest",
1044
+ "required": [
1045
+ "ibn:input"
1046
+ ],
1047
+ "type": "object",
1048
+ "properties": {
1049
+ "ibn:input": {
1050
+ "$ref": "#/components/schemas/IbnInput6"
1051
+ }
1052
+ },
1053
+ "example": {
1054
+ "ibn:input": {
1055
+ "search-from": "ES",
1056
+ "filter": {
1057
+ "intent-type-list": {
1058
+ "intent-type": "ont",
1059
+ "intent-type-version": "4"
1060
+ },
1061
+ "target": "INES-1-1-4-3-a",
1062
+ "predicate": "MATCHES",
1063
+ "required-network-state": "active",
1064
+ "order-by": "asc.intent-type",
1065
+ "config-required": "true"
1066
+ },
1067
+ "page-number": "0",
1068
+ "page-size": "10"
1069
+ }
1070
+ }
1071
+ },
1072
+ "IbnInput6": {
1073
+ "title": "IbnInput6",
1074
+ "required": [
1075
+ "search-from",
1076
+ "filter",
1077
+ "page-number",
1078
+ "page-size"
1079
+ ],
1080
+ "type": "object",
1081
+ "properties": {
1082
+ "search-from": {
1083
+ "type": "string"
1084
+ },
1085
+ "filter": {
1086
+ "$ref": "#/components/schemas/Filter6"
1087
+ },
1088
+ "page-number": {
1089
+ "type": "string"
1090
+ },
1091
+ "page-size": {
1092
+ "type": "string"
1093
+ }
1094
+ },
1095
+ "example": {
1096
+ "search-from": "ES",
1097
+ "filter": {
1098
+ "intent-type-list": {
1099
+ "intent-type": "ont",
1100
+ "intent-type-version": "4"
1101
+ },
1102
+ "target": "INES-1-1-4-3-a",
1103
+ "predicate": "MATCHES",
1104
+ "required-network-state": "active",
1105
+ "order-by": "asc.intent-type",
1106
+ "config-required": "true"
1107
+ },
1108
+ "page-number": "0",
1109
+ "page-size": "10"
1110
+ }
1111
+ },
1112
+ "Filter6": {
1113
+ "title": "Filter6",
1114
+ "required": [
1115
+ "intent-type-list",
1116
+ "target",
1117
+ "predicate",
1118
+ "required-network-state",
1119
+ "order-by",
1120
+ "config-required"
1121
+ ],
1122
+ "type": "object",
1123
+ "properties": {
1124
+ "intent-type-list": {
1125
+ "$ref": "#/components/schemas/IntentTypeList6"
1126
+ },
1127
+ "target": {
1128
+ "type": "string"
1129
+ },
1130
+ "predicate": {
1131
+ "type": "string"
1132
+ },
1133
+ "required-network-state": {
1134
+ "type": "string"
1135
+ },
1136
+ "order-by": {
1137
+ "type": "string"
1138
+ },
1139
+ "config-required": {
1140
+ "type": "string"
1141
+ }
1142
+ },
1143
+ "example": {
1144
+ "intent-type-list": {
1145
+ "intent-type": "ont",
1146
+ "intent-type-version": "4"
1147
+ },
1148
+ "target": "INES-1-1-4-3-a",
1149
+ "predicate": "MATCHES",
1150
+ "required-network-state": "active",
1151
+ "order-by": "asc.intent-type",
1152
+ "config-required": "true"
1153
+ }
1154
+ },
1155
+ "IntentTypeList6": {
1156
+ "title": "IntentTypeList6",
1157
+ "required": [
1158
+ "intent-type",
1159
+ "intent-type-version"
1160
+ ],
1161
+ "type": "object",
1162
+ "properties": {
1163
+ "intent-type": {
1164
+ "type": "string"
1165
+ },
1166
+ "intent-type-version": {
1167
+ "type": "string"
1168
+ }
1169
+ },
1170
+ "example": {
1171
+ "intent-type": "ont",
1172
+ "intent-type-version": "4"
1173
+ }
1174
+ },
1175
+ "Createl2-userRequest": {
1176
+ "title": "Createl2-userRequest",
1177
+ "required": [
1178
+ "ibn:intent"
1179
+ ],
1180
+ "type": "object",
1181
+ "properties": {
1182
+ "ibn:intent": {
1183
+ "$ref": "#/components/schemas/IbnIntent1"
1184
+ }
1185
+ },
1186
+ "example": {
1187
+ "ibn:intent": {
1188
+ "target": "HSI_Bronze#INES-1-1-4-3-a",
1189
+ "intent-type": "l2-user",
1190
+ "intent-type-version": "4",
1191
+ "required-network-state": "active",
1192
+ "intent-specific-data": {
1193
+ "l2-user:l2-user": {
1194
+ "service-profile": "HSI-100M-10M",
1195
+ "user-device-name": "INES-1-1-4-3-a",
1196
+ "q-vlan-id": "30",
1197
+ "uni-id": "LAN1"
1198
+ }
1199
+ }
1200
+ }
1201
+ }
1202
+ },
1203
+ "IbnIntent1": {
1204
+ "title": "IbnIntent1",
1205
+ "required": [
1206
+ "target",
1207
+ "intent-type",
1208
+ "intent-type-version",
1209
+ "required-network-state",
1210
+ "intent-specific-data"
1211
+ ],
1212
+ "type": "object",
1213
+ "properties": {
1214
+ "target": {
1215
+ "type": "string"
1216
+ },
1217
+ "intent-type": {
1218
+ "type": "string"
1219
+ },
1220
+ "intent-type-version": {
1221
+ "type": "string"
1222
+ },
1223
+ "required-network-state": {
1224
+ "type": "string"
1225
+ },
1226
+ "intent-specific-data": {
1227
+ "$ref": "#/components/schemas/IntentSpecificData1"
1228
+ }
1229
+ },
1230
+ "example": {
1231
+ "target": "HSI_Bronze#INES-1-1-4-3-a",
1232
+ "intent-type": "l2-user",
1233
+ "intent-type-version": "4",
1234
+ "required-network-state": "active",
1235
+ "intent-specific-data": {
1236
+ "l2-user:l2-user": {
1237
+ "service-profile": "HSI-100M-10M",
1238
+ "user-device-name": "INES-1-1-4-3-a",
1239
+ "q-vlan-id": "30",
1240
+ "uni-id": "LAN1"
1241
+ }
1242
+ }
1243
+ }
1244
+ },
1245
+ "IntentSpecificData1": {
1246
+ "title": "IntentSpecificData1",
1247
+ "required": [
1248
+ "l2-user:l2-user"
1249
+ ],
1250
+ "type": "object",
1251
+ "properties": {
1252
+ "l2-user:l2-user": {
1253
+ "$ref": "#/components/schemas/L2UserL2User"
1254
+ }
1255
+ },
1256
+ "example": {
1257
+ "l2-user:l2-user": {
1258
+ "service-profile": "HSI-100M-10M",
1259
+ "user-device-name": "INES-1-1-4-3-a",
1260
+ "q-vlan-id": "30",
1261
+ "uni-id": "LAN1"
1262
+ }
1263
+ }
1264
+ },
1265
+ "L2UserL2User": {
1266
+ "title": "L2UserL2User",
1267
+ "required": [
1268
+ "service-profile",
1269
+ "user-device-name",
1270
+ "q-vlan-id",
1271
+ "uni-id"
1272
+ ],
1273
+ "type": "object",
1274
+ "properties": {
1275
+ "service-profile": {
1276
+ "type": "string"
1277
+ },
1278
+ "user-device-name": {
1279
+ "type": "string"
1280
+ },
1281
+ "q-vlan-id": {
1282
+ "type": "string"
1283
+ },
1284
+ "uni-id": {
1285
+ "type": "string"
1286
+ }
1287
+ },
1288
+ "example": {
1289
+ "service-profile": "HSI-100M-10M",
1290
+ "user-device-name": "INES-1-1-4-3-a",
1291
+ "q-vlan-id": "30",
1292
+ "uni-id": "LAN1"
1293
+ }
1294
+ },
1295
+ "Getl2-userconfigurationRequest": {
1296
+ "title": "Getl2-userconfigurationRequest",
1297
+ "required": [
1298
+ "ibn:input"
1299
+ ],
1300
+ "type": "object",
1301
+ "properties": {
1302
+ "ibn:input": {
1303
+ "$ref": "#/components/schemas/IbnInput"
1304
+ }
1305
+ },
1306
+ "example": {
1307
+ "ibn:input": {
1308
+ "filter": {
1309
+ "intent-type-list": {
1310
+ "intent-type": "l2-user"
1311
+ },
1312
+ "target": "HSI_Bronze#INES-1-1-4-3-a",
1313
+ "predicate": "MATCHES",
1314
+ "required-network-state": "active",
1315
+ "order-by": "asc.intent-type",
1316
+ "config-required": "true"
1317
+ },
1318
+ "page-number": "0",
1319
+ "page-size": "10"
1320
+ }
1321
+ }
1322
+ },
1323
+ "SearchformisalignedintentsRequest": {
1324
+ "title": "SearchformisalignedintentsRequest",
1325
+ "required": [
1326
+ "ibn:input"
1327
+ ],
1328
+ "type": "object",
1329
+ "properties": {
1330
+ "ibn:input": {
1331
+ "$ref": "#/components/schemas/IbnInput8"
1332
+ }
1333
+ },
1334
+ "example": {
1335
+ "ibn:input": {
1336
+ "filter": {
1337
+ "aligned": "false"
1338
+ },
1339
+ "page-number": "0",
1340
+ "page-size": "10"
1341
+ }
1342
+ }
1343
+ },
1344
+ "IbnInput8": {
1345
+ "title": "IbnInput8",
1346
+ "required": [
1347
+ "filter",
1348
+ "page-number",
1349
+ "page-size"
1350
+ ],
1351
+ "type": "object",
1352
+ "properties": {
1353
+ "filter": {
1354
+ "$ref": "#/components/schemas/Filter8"
1355
+ },
1356
+ "page-number": {
1357
+ "type": "string"
1358
+ },
1359
+ "page-size": {
1360
+ "type": "string"
1361
+ }
1362
+ },
1363
+ "example": {
1364
+ "filter": {
1365
+ "aligned": "false"
1366
+ },
1367
+ "page-number": "0",
1368
+ "page-size": "10"
1369
+ }
1370
+ },
1371
+ "Filter8": {
1372
+ "title": "Filter8",
1373
+ "required": [
1374
+ "aligned"
1375
+ ],
1376
+ "type": "object",
1377
+ "properties": {
1378
+ "aligned": {
1379
+ "type": "string"
1380
+ }
1381
+ },
1382
+ "example": {
1383
+ "aligned": "false"
1384
+ }
1385
+ },
1386
+ "Modifyl2-userRequest": {
1387
+ "title": "Modifyl2-userRequest",
1388
+ "required": [
1389
+ "ibn:intent"
1390
+ ],
1391
+ "type": "object",
1392
+ "properties": {
1393
+ "ibn:intent": {
1394
+ "$ref": "#/components/schemas/IbnIntent2"
1395
+ }
1396
+ },
1397
+ "example": {
1398
+ "ibn:intent": {
1399
+ "intent-type": "l2-user",
1400
+ "intent-type-version": 4,
1401
+ "intent-specific-data": {
1402
+ "l2-user:l2-user": {
1403
+ "service-profile": "HSI-100M-10M-16MAC"
1404
+ }
1405
+ }
1406
+ }
1407
+ }
1408
+ },
1409
+ "IbnIntent2": {
1410
+ "title": "IbnIntent2",
1411
+ "required": [
1412
+ "intent-type",
1413
+ "intent-type-version",
1414
+ "intent-specific-data"
1415
+ ],
1416
+ "type": "object",
1417
+ "properties": {
1418
+ "intent-type": {
1419
+ "type": "string"
1420
+ },
1421
+ "intent-type-version": {
1422
+ "type": "integer",
1423
+ "format": "int32"
1424
+ },
1425
+ "intent-specific-data": {
1426
+ "$ref": "#/components/schemas/IntentSpecificData2"
1427
+ }
1428
+ },
1429
+ "example": {
1430
+ "intent-type": "l2-user",
1431
+ "intent-type-version": 4,
1432
+ "intent-specific-data": {
1433
+ "l2-user:l2-user": {
1434
+ "service-profile": "HSI-100M-10M-16MAC"
1435
+ }
1436
+ }
1437
+ }
1438
+ },
1439
+ "IntentSpecificData2": {
1440
+ "title": "IntentSpecificData2",
1441
+ "required": [
1442
+ "l2-user:l2-user"
1443
+ ],
1444
+ "type": "object",
1445
+ "properties": {
1446
+ "l2-user:l2-user": {
1447
+ "$ref": "#/components/schemas/L2UserL2User1"
1448
+ }
1449
+ },
1450
+ "example": {
1451
+ "l2-user:l2-user": {
1452
+ "service-profile": "HSI-100M-10M-16MAC"
1453
+ }
1454
+ }
1455
+ },
1456
+ "L2UserL2User1": {
1457
+ "title": "L2UserL2User1",
1458
+ "required": [
1459
+ "service-profile"
1460
+ ],
1461
+ "type": "object",
1462
+ "properties": {
1463
+ "service-profile": {
1464
+ "type": "string"
1465
+ }
1466
+ },
1467
+ "example": {
1468
+ "service-profile": "HSI-100M-10M-16MAC"
1469
+ }
1470
+ },
1471
+ "LockontRequest": {
1472
+ "title": "LockontRequest",
1473
+ "required": [
1474
+ "ibn:intent"
1475
+ ],
1476
+ "type": "object",
1477
+ "properties": {
1478
+ "ibn:intent": {
1479
+ "$ref": "#/components/schemas/IbnIntent3"
1480
+ }
1481
+ },
1482
+ "example": {
1483
+ "ibn:intent": {
1484
+ "intent-type-version": 4,
1485
+ "required-network-state": "suspend"
1486
+ }
1487
+ }
1488
+ },
1489
+ "IbnIntent3": {
1490
+ "title": "IbnIntent3",
1491
+ "required": [
1492
+ "intent-type-version",
1493
+ "required-network-state"
1494
+ ],
1495
+ "type": "object",
1496
+ "properties": {
1497
+ "intent-type-version": {
1498
+ "type": "integer",
1499
+ "format": "int32"
1500
+ },
1501
+ "required-network-state": {
1502
+ "type": "string"
1503
+ }
1504
+ },
1505
+ "example": {
1506
+ "intent-type-version": 4,
1507
+ "required-network-state": "suspend"
1508
+ }
1509
+ },
1510
+ "UnlockontRequest": {
1511
+ "title": "UnlockontRequest",
1512
+ "required": [
1513
+ "ibn:intent"
1514
+ ],
1515
+ "type": "object",
1516
+ "properties": {
1517
+ "ibn:intent": {
1518
+ "$ref": "#/components/schemas/IbnIntent3"
1519
+ }
1520
+ },
1521
+ "example": {
1522
+ "ibn:intent": {
1523
+ "intent-type-version": 4,
1524
+ "required-network-state": "active"
1525
+ }
1526
+ }
1527
+ }
1528
+ },
1529
+ "securitySchemes": {
1530
+ "httpBasic": {
1531
+ "type": "http",
1532
+ "scheme": "basic"
1533
+ }
1534
+ }
1535
+ },
1536
+ "security": [
1537
+ {
1538
+ "httpBasic": []
1539
+ }
1540
+ ],
1541
+ "tags": [
1542
+ {
1543
+ "name": "Intent"
1544
+ }
1545
+ ]
1546
+ }