VNFPackageManagement.yaml 63.1 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 1231 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 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 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 1313 1314 1315 1316 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 1354 1355 1356 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 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
            type: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications

    IndividualVnfPackageVnfd.Get:
      description: |
        200 OK
        Shall be returned when the content of the VNFD has been read successfully. The payload body shall contain a
        copy of the file representing the VNFD or a ZIP file that contains the file or multiple files representing
        the VNFD, as specified above. The "Content-Type" HTTP header shall be set according to the format of the
        returned file, i.e. to "text/plain" for a YAML file or to "application/zip" for a ZIP file.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageExtArtifacts.Get:
      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: |
            Version of the API used in the response.
          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:
            type: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig

    IndividualVnfPackageExtArtifacts.Put.200:
      description: |
        200 OK
        Shall be returned when the attribute "onboardingState" = "CREATED" or when the attribute "onboardingState" = "ERROR"
        and the VNF 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: |
            Version of the API used in the response.
          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:
            type: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig

    IndividualVnfPackageExtArtifacts.Put.202:
      description: |
        202 ACCEPTED
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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
        Location:
          description: The resource URI of the created NS instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content: {}

    IndividualVnfPackageManifest.Get:
      description: |
        200 OK
        Shall be returned when the content of the manifest has been read successfully. If the "include_signatures" URI
        query parameter was absent in the request, or if the manifest file has all security-related information embedded
        (i.e. there is no separate certificate file), the payload body shall contain a copy of the manifest file of the
        VNF package, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI
        query parameter was present in the related request and the manifest file does not have all the security-related
        information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to
        "application/zip and the payload body shall contain a ZIP archive which includes: - a copy of the manifest file
        of the VNF package - a copy of the related individual certificate file.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageContent.Get:
      description: |
        200 OK
        Shall be returned when the whole content of the VNF package file has been read successfully. The response body
        shall include a copy of the VNF package file. The "Content-Type" HTTP header shall be set according to the type
        of the file, i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageContent.Put:
      description: |
        202 ACCEPTED
        Shall be returned when the VNF 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. See note.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageArtifacts.Get:
      description: |
        200 OK
        Shall be returned when the whole content of the archive containing the artifact files has been read successfully.
        The payload body shall be a ZIP archive containing the requested set of artifacts selected according to the provisions
        specified above in this clause, and, if the flag "include_signatures" was provided in the related request, the
        applicable signature files and, if available, the separate certificate files from the VNF package.
        The "Content-Type" HTTP header shall be set to "application/zip".
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageUploadFromUri.Post:
      description: |
        202 Accepted
        The information about the VNF package has been received successfully, but the on-boarding has not been completed.
        It is expected to take some time for processing. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageArtifact.Get:
      description: |
        200 OK Shall be returned when the whole content of the artifact file has been read successfully. If the
        "include_signatures" request URI parameter was not provided in the related request, the payload body shall
        contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5], and the
        "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the artifact
        is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193 [17]). If the content
        type cannot be determined, the header shall be set to the value "application/octet-stream".
        If the "include_signatures" request URI parameter was provided in the related request, the "ContentType"
        HTTP header shall be set to "application/zip" and the payload body shall contain a ZIP archive which includes:
        - a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5];
        - the related security information (individual signature file and optional related individual certificate file).
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    VnfPkgSubscriptions.Get:
      description: |
        200 OK
        Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain
        in an array the representations of all active subscriptions of the functional block that invokes the method,
        i.e. zero or more representations of VNF package management subscriptions, as defined in clause 9.5.2.7.
        If the "filter" URI parameter was supplied in the request, the data in the response body shall have been
        transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the NFVO supports
        alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource, inclusion of the
        Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV SOL 013.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            type: array
            items:
              $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription

    VnfPkgSubscriptions.Post:
      description: |
        201 Created
        Shall be returned when the subscription has been created successfully. The response body shall contain a
        representation of the created "Individual subscription" resource. The HTTP response shall include a "Location"
        HTTP header that points to the created subscription resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription

    VnfPkgSubscription.Get:
      description: |
        200 OK
        Shall be returned when information about an individual subscription has been read successfully.
        The response body shall contain a representation of the "Individual subscription" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription

    VnfPkgSubscription.Delete:
      description: |
        No Content
        Shall be returned when information about an individual subscription has been read successfully. The response
        body shall contain a representation of the "Individual subscription" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}