NSLifecycleManagement.yaml 74.2 KB
Newer Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
###############################################################################
# Rollback a NS lifecycle management operation occurrence.                    #
###############################################################################
  '/ns_lcm_op_occs/{nsLcmOpOccId}/rollback':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.12
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be rolled back.
rameshnaraya's avatar
rameshnaraya committed
1030
          
1031
1032
1033
1034
1035
1036
1037
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1038
      summary: Rollback a NS lifecycle management operation occurrence.
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
      description: >
        The POST method initiates rolling back a NS lifecycle operation 
        if that operation has experienced a temporary failure,
        i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
        This method shall follow the provisions specified in the 
        Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

###############################################################################
# Continue a NS lifecycle management operation occurrence.                    #
###############################################################################
  '/ns_lcm_op_occs/{nsLcmOpOccId}/continue':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.13
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be continued.
        in: path
        required: true
        type: string
    post:    
rameshnaraya's avatar
rameshnaraya committed
1089
      summary: Continue a NS lifecycle management operation occurrence.
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
      description: >
        The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure,
        i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
        This method shall follow the provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
###############################################################################
# Fail operation task                                                         #
###############################################################################
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
1129
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.14
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
          
          This identifier can be retrieved from the resource referenced by 
          he "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. 
          It can also be retrieved from the "nsLcmOpOccId"
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1144
      summary: Mark a NS lifecycle management operation occurrence as failed.
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
      description: >
        The POST method marks a NS lifecycle management operation 
        occurrence as "finally failed" if that operation
        occurrence is in "FAILED_TEMP" state.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        200:
1166
          description: 200 OK
rameshnaraya's avatar
rameshnaraya committed
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
          schema:
            type: "object"
            description: >
              The state of the NS lifecycle management operation
              occurrence was changed successfully.
              The response shall include a representation of the NS
              lifecycle management operation occurrence resource.
            properties:
              NsLcmOpOcc:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
1177
1178
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1179
1180
1181
1182
1183
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
1184
              maximum: 1
rameshnaraya's avatar
rameshnaraya committed
1185
              minimum: 1                
1186
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1187
              type: "string"
1188
1189
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1190
1191
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1192
              maximum: 1
rameshnaraya's avatar
rameshnaraya committed
1193
              minimum: 0         
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
###############################################################################
# Cancel operation task                                                       #
###############################################################################
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
1217
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.15
1218
1219
1220
1221
1222
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be canceled.
          
rameshnaraya's avatar
rameshnaraya committed
1223
1224
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
1225
1226
1227
1228
1229
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1230
      summary: Cancel a NS lifecycle management operation occurrence.
1231
1232
1233
1234
1235
1236
1237
1238
1239
      description: >
        The POST method initiates canceling an ongoing NS lifecycle 
        management operation while it is being executed or
        rolled back, i.e. the related "NS LCM operation occurrence" is 
        either in "PROCESSING" or "ROLLING_BACK" state.
        This method shall follow the provisions specified in the 
        Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
      parameters:
rameshnaraya's avatar
rameshnaraya committed
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Content-Type
        description: >
          The MIME type of the body of the request.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "CancelMode"
          properties:
            CancelMode:
              $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/CancelMode"
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
          description: >
            The POST request to this resource shall include a CancelMode
            structure in the payload body to choose between "graceful" and
            "forceful" cancellation.
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          description: > 
1292
            409 Conflict.
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309

            Error: The operation cannot be executed currently, due
            to a conflict with the state of the NS LCM operation
            occurrence resource.
            Typically, this is due to the fact that the operation
            occurrence is not in STARTING, PROCESSING or
            ROLLING_BACK state.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1310
              type: "string"
1311
1312
              description: >
                Challenge if the corresponding HTTP request has not provided
1313
1314
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
              maximum: 1
              minimum: 0
          schema:
            $ref: "definitions/SOL005_def.yaml#/definitions/ProblemDetails"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

###############################################################################
# Subscriptions                                                               #
###############################################################################
  '/subscriptions':
1328
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.16
1329
    post: 
rameshnaraya's avatar
rameshnaraya committed
1330
      summary: Subscribe to NS lifecycle change notifications.
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
      description: >
        The POST method creates a new subscription.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.16.3.1-1 and 6.4.16.3.1-2.
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
        Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
        same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
        to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
        the existing subscription resource with the same filter and callbackUri).
      parameters:
rameshnaraya's avatar
rameshnaraya committed
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Content-Type
        description: >
          The MIME type of the body of the request.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "LccnSubscriptionRequest"
          properties:
            LccnSubscriptionRequest:
              $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
1373
          description: >
rameshnaraya's avatar
rameshnaraya committed
1374
            Details of the subscription to be created, as defined in clause 6.5.2.2.
1375
1376
      responses:
        201:
1377
1378
1379
1380
1381
1382
1383
1384
          description: >
            201 Created
            
            The subscription was created successfully.
            The response body shall contain a representation of
            the created subscription resource.
            The HTTP response shall include a "Location:"
            HTTP header that points to the created subscription resource.            
rameshnaraya's avatar
rameshnaraya committed
1385
          schema:
1386
            type: "object"  
rameshnaraya's avatar
rameshnaraya committed
1387
1388
1389
            properties:
              LccnSubscription:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
1390
          headers:
rameshnaraya's avatar
rameshnaraya committed
1391
1392
1393
1394
1395
1396
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
1397
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1398
              type: "string"
1399
1400
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1401
1402
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1403
1404
              maximum: 1
              minimum: 0
1405
1406
        303:
          description: > 
1407
1408
            See Other.
            
1409
1410
1411
1412
1413
1414
1415
1416
1417
            A subscription with the same callbackURI and the
            same filter already exits and the policy of the NFVO
            is to not create redundant subscriptions.
            The HTTP response shall include a "Location"
            HTTP header that contains the resource URI of the
            existing subscription resource.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
1418
              type: "string"
1419
1420
              description: >
                Challenge if the corresponding HTTP request has not provided
1421
1422
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
              maximum: 1
              minimum: 0
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    get: 
rameshnaraya's avatar
rameshnaraya committed
1442
      summary: Query multiple subscriptions.
1443
      description: >
1444
        Query Subscription Information.
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465

        The GET method queries the list of active subscriptions of the
        functional block that invokes the method. It can be used e.g. for
        resynchronization after error situations.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1466
          description: >
1467
            200 OK
rameshnaraya's avatar
rameshnaraya committed
1468
1469
1470
1471
            
            The list of subscriptions was queried successfully.
            The response body shall contain the representations of
            all active subscriptions of the functional block that
1472
            invokes the method.
1473
1474
          headers:
            Content-Type:
1475
1476
1477
1478
1479
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
1480
            WWW-Authenticate:
1481
              type: "string"
1482
1483
              description: >
                Challenge if the corresponding HTTP request has not provided
1484
1485
1486
1487
1488
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0             

1489
          schema:
rameshnaraya's avatar
rameshnaraya committed
1490
1491
1492
1493
1494
            type: array
            items:
              properties:
                LccnSubscription:
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
1495
1496
        400:
          description: > 
1497
            Bad Request.
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509

            Invalid attribute-based filtering parameters.
            The response body shall contain a ProblemDetails structure, in
            which the "detail" attribute should convey more information about
            the error.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1510
              type: "string"
1511
1512
              description: >
                Challenge if the corresponding HTTP request has not provided
1513
1514
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
              maximum: 1
              minimum: 0
          schema:
            $ref: "definitions/SOL005_def.yaml#/definitions/ProblemDetails"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/subscriptions/{subscriptionId}':
1538
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.17
1539
1540
1541
1542
1543
1544
1545
1546
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
        in: path
        type: string
        required: true
    get:
rameshnaraya's avatar
rameshnaraya committed
1547
      summary: Read an individual subscription resource.
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
      description: >
        The GET method retrieves information about a subscription by reading an individual subscription resource.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.17.3.2-1 and 6.4.17.3.2-2
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
rameshnaraya's avatar
rameshnaraya committed
1567
      responses:              
1568
        200:
1569
1570
1571
1572
1573
1574
          description: >
            200 OK
            
            The operation has completed successfully.
            The response body shall contain a representation of
            the subscription resource.            
rameshnaraya's avatar
rameshnaraya committed
1575
          schema:
1576
            type: "object"  
rameshnaraya's avatar
rameshnaraya committed
1577
1578
1579
            properties:
              LccnSubscription:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
1580
1581
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1582
1583
1584
1585
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
1586
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1587
              type: "string"
1588
1589
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1590
                authorization, or error details if the corresponding HTTP request
1591
1592
1593
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0              
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    delete:
rameshnaraya's avatar
rameshnaraya committed
1611
      summary: Terminate a subscription.
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
      description: >
        The DELETE method terminates an individual subscription.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
          description: > 
1627
            204 No Content
1628
1629
            
            The subscription resource was deleted successfully.
rameshnaraya's avatar
rameshnaraya committed
1630
            The response body shall be empty.
1631
1632
          headers:
            WWW-Authenticate:
1633
              type: "string"
1634
1635
              description: >
                Challenge if the corresponding HTTP request has not provided
1636
1637
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
              maximum: 1
              minimum: 0
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1655
1656
1657
1658
1659
1660
##################################################################################
# Notification endpoint                                                          #
# Dummy URI is used for testing.                                                 #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription-NsLcmOperationOccurrenceNotification':
1661
1662
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
    post:
1663
      summary: Notify about NS lifecycle change
1664
1665
1666
1667
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.
1668

1669
      parameters:
rameshnaraya's avatar
rameshnaraya committed
1670
        - name: NsLcmOperationOccurrenceNotification
1671
          description: >
rameshnaraya's avatar
rameshnaraya committed
1672
1673
            A notification about lifecycle changes triggered by a NS LCM.
            operation occurrence.  
1674
1675
1676
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
1677
1678
1679
            properties:
              NsLcmOperationOccurrenceNotification:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOperationOccurrenceNotification"
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string      
      responses:
        204:
          description: >
1704
1705
            204 No Content          
            
1706
1707
            The notification was delivered successfully.
          headers:
1708
1709
1710
1711
1712
1713
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1714
              maximum: 1
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
              minimum: 0        
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 

  '/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierCreationNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
    post:
      summary: Notify about NS lifecycle change
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.

      parameters:
        - name: NsIdentifierCreationNotification
          description: >
            A notification about the creation of a NS identifier and the related
            NS instance resource.
          in: body
          required: true
          schema:
           properties:
             NsIdentifierCreationNotification:           
               $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsIdentifierCreationNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string      
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
1785
            WWW-Authenticate:
1786
              type: "string"
1787
1788
              description: >
                Challenge if the corresponding HTTP request has not provided
1789
1790
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1791
              maximum: 1
rameshnaraya's avatar
rameshnaraya committed
1792
              minimum: 0         
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
          $ref: "responses/SOL005_resp.yaml#/responses/503"  
          
  '/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierDeletionNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
    post:
      summary: Notify about NS lifecycle change
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.

      parameters:
        - name: NsIdentifierDeletionNotification
          description: >
            A notification about the deletion of a NS identifier and the related
            NS instance resource.
          in: body
          required: true
          schema:
           properties:
             NsIdentifierDeletionNotification:   
               $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsIdentifierDeletionNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string      
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0         
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"            
          
1891
    get:
rameshnaraya's avatar
rameshnaraya committed
1892
      summary: Test the notification endpoint.
1893
      description: >
1894
        Query NS Instances.
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
        
        The GET method queries information about multiple NS instances.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1914
      responses:
rameshnaraya's avatar
rameshnaraya committed
1915
        204:
1916
          description: >
1917
1918
1919
            204 No Content
            
            The notification endpoint was tested successfully.
rameshnaraya's avatar
rameshnaraya committed
1920
            The response body shall be empty.
1921
1922
          headers:
            WWW-Authenticate:
1923
              type: "string"
1924
1925
              description: >
                Challenge if the corresponding HTTP request has not provided
1926
1927
1928
1929
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
1930
1931
1932
1933
1934
1935
1936
1937
1938
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
1939
          $ref: "responses/SOL005_resp.yaml#/responses/405"
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
For faster browsing, not all history is shown. View entire blame