VNFLifecycleManagement.yaml 86.8 KB
Newer Older
Gergely Csatari's avatar
Gergely Csatari committed
1001
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location"
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1020
1021
1022
  ###############################################################################
  # Heal VNF task                                                               #
  ###############################################################################
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
  '/vnf_instances/{vnfInstanceId}/heal':
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be healed. This identifier can be
          retrieved from the resource referenced by the "Location" HTTP
          header in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1036
    post:
1037
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1038
1039
1040
        Heal VNF


1041
1042
1043
1044
1045
1046
1047
1048
        The POST method requests to heal a VNF instance resource.
      parameters:
        - name: HealVnfRequest
          description: Parameters for the Heal VNF operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
        - 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
1070
1071
1072
1073
1074
1075
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1076
1077
      responses:
        202:
Gergely Csatari's avatar
Gergely Csatari committed
1078
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location"
1079
1080
1081
1082
1083
1084
1085
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1086
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1097
1098
1099
  ###############################################################################
  # Operate VNF task                                                            #
  ###############################################################################
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
  '/vnf_instances/{vnfInstanceId}/operate':
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be operated. This identifier can
          be retrieved from the resource referenced by the "Location" HTTP
          header in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1113
    post:
1114
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1115
1116
1117
        Operate VNF


1118
1119
1120
1121
1122
1123
1124
1125
        The POST method changes the operational state of a VNF instance resource.
      parameters:
        - name: OperateVnfRequest
          description: Parameters for the Operate VNF operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
        - 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
1147
1148
1149
1150
1151
1152
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1153
1154
      responses:
        202:
Gergely Csatari's avatar
Gergely Csatari committed
1155
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location"
1156
1157
1158
1159
1160
1161
1162
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1163
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1174
1175
1176
  ###############################################################################
  # Change external VNF connectivity task                                       #
  ###############################################################################
1177
  '/vnf_instances/{vnfInstanceId}/change_ext_conn':
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance of which the external connectivity is
          requested to be changed. This identifier can be retrieved from the
          resource referenced by the "Location" HTTP header in the response to
          a POST request creating a new VNF instance resource. It can also be
          retrieved from the "id" attribute in the payload body of that
          response.
        in: path
        type: string
        required: true
1191
    post:
1192
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1193
1194
1195
        Change External VNF Connectivity


1196
1197
1198
        The POST method changes the external connectivity of a VNF instance.
      parameters:
        - name: ChangeExtVnfConnectivityRequest
1199
          description: >
1200
1201
1202
1203
1204
            Parameters for the Change external VNF connectivity operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
        - 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
1226
1227
1228
1229
1230
1231
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1232
1233
      responses:
        202:
Gergely Csatari's avatar
Gergely Csatari committed
1234
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location"
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-another-lcm-operation-ongoing"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1253
1254
1255
  ###############################################################################
  # VNF LCM operation occurrences                                               #
  ###############################################################################
1256
1257
  '/vnf_lcm_op_occs':
    #SOL003 location: 5.4.12
1258
    get:
1259
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1260
1261
1262
        Get Operation Status


1263
1264
        The client can use this method to query status information about
        multiple VNF lifecycle management operation occurrences.
Gergely Csatari's avatar
Gergely Csatari committed
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
      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
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VnfLcmOpOcc and in data 
            types referenced from it shall be supported by the VNFM in the 
            filter expression.
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
            The following attributes shall be excluded from the VnfLcmOpOcc structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            -	vnfConfigurableProperties
            - vimConnectionInfo
            -	instantiatedVnfInfo
            -	metadata
            -	extensions
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 
            for this resource.
          in: query
          required: false
          type: string
1335
1336
1337
1338
1339
1340
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1341
1342
1343
      responses:
        200:
          description: >
1344
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
1345

1346
1347
            Status information for zero or more VNF lifecycle management
            operation occurrences was queried successfully. The response body
1348
1349
1350
1351
1352
1353
            shall contain in an array the status information about zero or 
            more VNF lifecycle operation occurrences.
            If the VNFM supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link 
            HTTP header in this response shall follow the provisions 
            in clause 4.7.2.3.
1354
1355
1356
1357
1358
1359
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
1360
1361
1362
1363
1364
1365
1366
1367
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
1368
1369
1370
1371
1372
1373
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1374
1375
1376
1377
1378
1379
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1400
1401
1402
  ###############################################################################
  # Individual VNF LCM operation occurrence                                     #
  ###############################################################################
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}':
    #SOL003 location: 5.4.13
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a PATCH or POST request
          triggering a VNF LCM operation. It can also be retrieved from the
          "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1417
    get:
1418
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1419
1420
1421
        Get Operation Status


1422
1423
1424
        The client can use this method to retrieve status information about a
        VNF lifecycle management operation occurrence by reading an individual
        "VNF LCM operation occurrence" resource.
Gergely Csatari's avatar
Gergely Csatari committed
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
      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
1440
1441
1442
1443
1444
1445
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1446
1447
1448
      responses:
        200:
          description: >
1449
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
1450

1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
            Information about an individual VNF instance was queried
            successfully. The response body shall contain status
            information about a VNF lifecycle management operation
            occurrence.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
1461
1462
1463
1464
1465
1466
1467
1468
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
1469
1470
1471
1472
1473
1474
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1495
1496
1497
  ###############################################################################
  # Retry operation task                                                        #
  ###############################################################################
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry':
    #SOL003 location: 5.4.14
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          retried. This identifier can be retrieved from the resource
          referenced by the "Location" HTTP header in the response to a PATCH
          or POST request triggering a VNF LCM operation. It can also be
          retrieved from the "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1512
    post:
1513
1514
1515
1516
      description: >
        The POST method initiates retrying a VNF lifecycle operation if that
        operation has experienced a temporary failure, i.e. the related
        "VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
Gergely Csatari's avatar
Gergely Csatari committed
1517
1518
1519
1520
1521
1522
1523
1524
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1525
1526
1527
1528
1529
1530
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1531
1532
      responses:
        202:
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
          description: >
            202 ACCEPTED

            The request was accepted for processing, but processing has not been completed.
            The response shall have an empty payload body.
          headers:
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
1552
1553
1554
1555
1556
1557
1558
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1559
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1570
1571
1572
  ###############################################################################
  # Rollback operation task                                                     #
  ###############################################################################
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback':
    #SOL003 location: 5.4.15  
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          be rolled back. This identifier can be retrieved from the resource
          referenced by the "Location" HTTP header in the response to a PATCH
          or POST request triggering a VNF LCM operation. It can also be
          retrieved from the "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1587
    post:
1588
1589
1590
1591
      description: >
        The POST method initiates rolling back a VNF lifecycle operation if
        that operation has experienced a temporary failure, i.e. the related
        "VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
Gergely Csatari's avatar
Gergely Csatari committed
1592
1593
1594
1595
1596
1597
1598
1599
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1600
1601
1602
1603
1604
1605
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1606
1607
      responses:
        202:
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
          description: >
            202 ACCEPTED

            The request was accepted for processing, but processing has not been completed.
            The response shall have an empty payload body.
          headers:
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
1627
1628
1629
1630
1631
1632
1633
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1634
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1645
1646
1647
  ###############################################################################
  # Fail operation task                                                         #
  ###############################################################################
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail':
    #SOL003 location: 5.4.16  
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          be marked as "failed". This identifier can be retrieved from the
          resource referenced by the "Location" HTTP header in the response to
          a PATCH or POST request triggering a VNF LCM operation. It can also
          be retrieved from the "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1662
    post:
1663
1664
1665
1666
      description: >
        The POST method marks a VNF lifecycle management operation occurrence
        as "finally failed" if that operation occurrence is in "FAILED_TEMP"
        state.
Gergely Csatari's avatar
Gergely Csatari committed
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
      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
1682
1683
1684
1685
1686
1687
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1688
1689
      responses:
        200:
1690
          description: >
1691
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
1692

1693
1694
1695
1696
1697
1698
1699
1700
1701
            The state of the VNF lifecycle management operation occurrence was
            changed successfully. The response shall include a representation
            of the VNF lifecycle operation occurrence resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
1702
1703
1704
1705
1706
1707
1708
1709
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
1710
1711
1712
1713
1714
1715
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1716
1717
1718
1719
1720
1721
1722
1723
1724
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1725
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1736
1737
1738
  ###############################################################################
  # Cancel operation task                                                       #
  ###############################################################################
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel':
    #SOL003 location: 5.4.17
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          be cancelled. This identifier can be retrieved from the
          resource referenced by the "Location" HTTP header in the response to
          a PATCH or POST request triggering a VNF LCM operation. It can also
          be retrieved from the "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1753
    post:
1754
1755
1756
1757
1758
      description: >
        The POST method initiates cancelling an ongoing VNF lifecycle
        operation while it is being executed or rolled back, i.e. the related
        "VNF LCM operation occurrence" is either in "PROCESSING" or
        "ROLLING_BACK" state.
Gergely Csatari's avatar
Gergely Csatari committed
1759
1760
1761
1762
1763
1764
1765
1766
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1767
1768
1769
1770
1771
1772
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1773
1774
      responses:
        202:
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
          description: >
            202 ACCEPTED

            The request was accepted for processing, but processing has not been completed.
            The response shall have an empty payload body.
          headers:
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
1794
1795
1796
1797
1798
1799
1800
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1801
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1802
1803
1804
1805
1806
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1807
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
1808
1809
            Conflict

1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
            The operation cannot be executed currently, due to a conflict with
            the state of the VNF 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
Gergely Csatari's avatar
Gergely Csatari committed
1823
1824
1825
1826
1827
1828
1829
1830
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
1831
          schema:
1832
            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
1833
1834
1835
1836
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1837
1838
1839
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
1840
1841
  '/subscriptions':
    #SOL003 location: 5.4.18
1842
    post:
1843
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1844
1845
1846
        Subscribe


1847
        The POST method creates a new subscription.
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
        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 NFVO, and might make sense only in
        very rare use cases. Consequently, the VNFM 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).
1858
1859
      parameters:
        - name: LccnSubscriptionRequest
1860
          description: >
1861
1862
1863
1864
1865
            Details of the subscription to be created.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
        - 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
1887
1888
1889
1890
1891
1892
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1893
1894
      responses:
        201:
1895
          description: >
1896
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
1897

1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
            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.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
1912
1913
1914
1915
1916
1917
1918
1919
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
1920
1921
1922
1923
1924
1925
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1926
1927
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
1928
        303:
1929
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
1930
1931
            See Other

1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
            A subscription with the same callbackURI and the same filter already
            exists and the policy of the VNFM 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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
1943
1944
1945
1946
1947
1948
1949
1950
            WWW-Authenticate:
              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.
              type: string
              maximum: 1
              minimum: 0
1951
1952
1953
1954
1955
1956
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1957
1958
1959
1960
1961
1962
1963
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1964
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1965
1966
1967
1968
1969
1970
1971
1972
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1973
    get:
1974
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
1975
1976
1977
        Query Subscription Information


1978
1979
1980
        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.
Gergely Csatari's avatar
Gergely Csatari committed
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
      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
1996
1997
1998
1999
2000
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
For faster browsing, not all history is shown. View entire blame