VNFSnapshotPackageManagement.yaml 56.5 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
1030
1031
1032
1033
1034
1035
1036
1037
1038
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
1089
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
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/zip:
          schema:
            type: string
            format: binary

    VnfSnapshotPackageContent.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, this response shall be returned when a single consecutive 
        byte range from the content of the VNF snapshot package file has been read successfully according
        to the request.

        The response body shall contain the requested part of the VNF snapshot package file. 

        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. 

        The "Content-Type" HTTP header shall be set as defined for the "200 OK" response.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Range:
          description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/zip:
          schema:
            type: string
            format: binary

    VnfSnapshotPackageContent.Put.202:
      description: |
        202 ACCEPTED

        Shall be returned when the VNF snapshot package has been accepted for uploading, but the
        processing has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string

    UploadFromUri.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information about the VNF snapshot package has been received successfully, but 
        the uploading has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string

    BuildVnfSnapshotPkg.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information for building the VNF snapshot package has been received successfully, but 
        the build has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string

    ExtractVnfSnapshotPkg.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information for extracting the VNF snapshot package has been received successfully, but 
        the extraction has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string

    CancelVnfSnapshotPkg.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information for cancelling the ongoing operation with the content of the VNF snapshot package 
        has been received successfully, but the stopping of the operation has not been completed. It is expected to take some 
        time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string

    ExternalArtifactsAccess.Get.200:
      description: |
        200 OK

        Shall be returned when the access configuration information has been read successfully. 

        If no information has been provided previously, an empty array shall be returned.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
1231
            $ref: definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessInfo
1232
1233
1234
1235
1236
1237
1238
1239
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

    ExternalArtifactsAccess.Put.200:
      description: |
        200 OK

        Shall be returned when the attribute "state" equals "CREATED" or when the attribute "state" equals "ERROR" 
        and the VNF snapshot package has not been uploaded successfully previously, to indicate that the access 
        configuration information has been stored successfully by the NFVO.

        The response body shall contain a representation of the state of the resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
1266
            $ref: definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessInfo
1267
1268
1269
1270
1271
1272
1273

    IndividualArtifact.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the artifact file has been read successfully.

1274
1275
        The response body shall include a copy of the artifact file from the VNF snapshot package. 
        The VNF snapshot package format is defined in ETSI GS NFV-SOL 010.
1276
1277
1278
1279
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

        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the 
        content type cannot be determined, the header shall be set to the value "application/octet-stream".        
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/*:
          schema:
            type: string
            format: binary
    
    IndividualArtifact.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, this response shall be returned when a single consecutive byte
        range from the content of the artifact file has been read successfully according to the request.

1313
1314
1315
1316
        The response body shall contain the requested part of the artifact file from the VNF snapshot package. 
        The VNF snapshot package format is defined in ETSI GS NFV-SOL 010. 
        
        The "Content-Type" HTTP header shall be set according to the content 
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
        type of the artifact file. If the content type cannot be determined, the header shall be set to the 
        value "application/octet-stream". 
        
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Range:
          description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/*:
          schema:
            type: string
            format: binary

1354
    IndividualArtifact.Get.302:
1355
      description: |
1356
        302 FOUND
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385

        Shall be returned if the referred "Individual VNF snapshot package artifact" is external to the main
        VNF snapshot package file created from a build process.

        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the artifact.

        The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: The resource URI of the artifact.
          style: simple
          explode: false
          schema:
            type: string
            format: url
For faster browsing, not all history is shown. View entire blame