Skip to content
GitLab
Find file Normal viewHistoryPermalink
MEC010-2_AppLcm.yaml 105 KB
Newer Older
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
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 
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}:
    get:
      tags:
      - 'app-lcm'
      summary:  'reads the status information of an individual application LCM operation occurrence'
      description: reads the status information of an individual application LCM operation occurrence
      operationId: appLcmOpOccsbyIdGET
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Information about an application LCM operation occurrence was read successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLcmOpOcc'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/cancel:
    post:
      tags:
      - 'app-lcm'
      summary: 'cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.'
      description: cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.
      operationId: appLcmCancelPOST
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelMode'
        required: true
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed.
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/fail:
    post:
      tags:
      - 'app-lcm'
      summary: marks an application lifecycle management operation occurrence as "finally failed"
      description: marks an application lifecycle management operation occurrence as "finally failed"
      operationId: appLcmFailPOST
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: Shall be returned when the state of the application lifecycle management operation occurrence has been changed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLcmOpOcc'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/retry:
    post:
      tags:
      - 'app-lcm'
      summary: initiate retrying an application lifecycle operation that has experience a temporary failure
      description: initiate retrying an application lifecycle operation that has experience a temporary failure
      operationId: appLcmRetryPOST
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []


## Resources of MEPM's application lifecycle management on Mm3
  /app_instances/{appInstanceId}/configure_platform_for_app:
    post:
      tags:
      - 'app-lcm'
      summary: provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.
      description: provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.
      operationId: appInstancesConfigPlatformPOST
      parameters:
      - name: appInstanceId
        in: path
        description: The identifier of the application instance.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The payload body in the request contains the information necessary to provide configuration information in AppD
        content:
          application/json:
            schema:
              $ref: './MEC010p2_v221_definitions.yaml#/definitions/ConfigPlatformForAppRequest'
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1375 1376 1377 
  /app_instances/{appInstanceId}/terminate:
    post:
      tags:
piscione's avatar
Updated specifications: fix on examples, callback and minor.  
piscione committed
1378 1379 
      - 'app-lcm'
      summary: 'terminate an application instance.'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1380 
      description: terminate an application instance.
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1381 
      operationId: appLcmTerminateOnMm3POST
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1382 1383 1384 1385 
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1386 
        required: true
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1387 1388 1389 1390 1391 
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1392 1393 1394 1395 
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TerminateAppRequest'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1396 
        required: true
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1397 1398 
      responses:
        '202':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1399 1400 1401 
          description: accepted for processing, but the processing has not yet been completed.
          headers: {}
          content: {}
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1402 
        '400':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1403 1404 1405 1406 1407 1408 
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1409 
        '401':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1410 1411 1412 1413 1414 1415 
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1416 
        '403':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1417 1418 1419 1420 1421 1422 
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1423 
        '404':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1424 1425 1426 1427 1428 1429 
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1430 
        '406':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1431 1432 1433 1434 1435 1436 
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1437 
        '409':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1438 1439 1440 1441 1442 1443 
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1444 
        '429':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1445 1446 1447 1448 1449 1450 1451 1452 
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1453
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1454 1455 1456 
  /app_instances/{appInstanceId}/operate:
    post:
      tags:
piscione's avatar
Updated specifications: fix on examples, callback and minor.  
piscione committed
1457 1458 
      - 'app-lcm'
      summary: 'change the operational state, i.e. start or stop, of the application instance'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1459 
      description: change the operational state, i.e. start or stop, of the application instance
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1460 
      operationId: appLcmOperateOnMm3POST
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1461 1462 1463 1464 
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1465 
        required: true
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1466 1467 1468 1469 1470 
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1471 1472 1473 1474 
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperateAppRequest'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1475 
        required: true
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1476 1477 
      responses:
        '202':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1478 1479 1480 
          description: accepted for processing, but the processing has not yet been completed.
          headers: {}
          content: {}
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1481 
        '400':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1482 1483 1484 1485 1486 1487 
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1488 
        '401':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1489 1490 1491 1492 1493 1494 
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1495 
        '403':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1496 1497 1498 1499 1500 1501 
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1502 
        '404':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1503 1504 1505 1506 1507 1508 
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1509 
        '406':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1510 1511 1512 1513 1514 1515 
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1516 
        '409':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1517 1518 1519 1520 1521 1522 
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1523 
        '429':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1524 1525 1526 1527 1528 1529 1530 1531 
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1532 1533 1534 
  /app_lcm_op_occs:
    get:
      tags:
piscione's avatar
Updated specifications: fix on examples, callback and minor.  
piscione committed
1535 1536 
      - 'app-lcm'
      summary: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1537 
      description: retrieves information of operation status about multiple application instance lifecycle management operation occurrences
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1538 
      operationId: appLcmOpOccsOnMm3GET
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1539 
      parameters:
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 
      - name: filter
        in: query
        description: Attribute-based filtering parameters according to ETSI GS MEC 009
        style: form
        explode: true
        schema:
          type: string
      - name: all_fields
        in: query
        description: Include all complex attributes in the response.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1556 
        description: Complex attributes of AppLcmOpOcc to be excluded from the response.
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1557 1558 1559 1560 1561 1562 
        style: form
        explode: true
        schema:
          type: string
      - name: exclude_fields
        in: query
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1563 
        description: Complex attributes of AppLcmOpOcc to be excluded from the response.
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1564 1565 1566 1567 1568 1569 
        style: form
        explode: true
        schema:
          type: string
      - name: exclude_default
        in: query
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1570 
        description: Indicates to exclude the following complex attributes of AppLcmOpOcc from the response.
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1571 1572 1573 1574 
        style: form
        explode: true
        schema:
          type: string
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1575 1576 
      responses:
        '200':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1577 1578 
          description: Status information for zero or more application instance lifecycle management operation occurrences was queried successfully
          headers: {}
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1579 1580 1581 1582 1583 
          content:
            application/json:
              schema:
                type: array
                items:
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1584 
                  $ref: '#/components/schemas/AppLcmOpOcc'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1585 1586 
                description: ''
                contentMediaType: application/json
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1587 
        '400':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1588 1589 1590 1591 1592 1593 
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1594 
        '401':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1595 1596 1597 1598 1599 1600 
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1601 
        '403':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1602 1603 1604 1605 1606 1607 
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1608 
        '404':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1609 1610 1611 1612 1613 1614 
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1615 
        '406':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1616 1617 1618 1619 1620 1621 
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1622 
        '429':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1623 1624 1625 1626 1627 1628 1629 1630 
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1631 1632 1633 
  /app_lcm_op_occs/{appLcmOpOccId}:
    get:
      tags:
piscione's avatar
Updated specifications: fix on examples, callback and minor.  
piscione committed
1634 1635 
      - 'app-lcm'
      summary:  'reads the status information of an individual application LCM operation occurrence'
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1636 
      description: reads the status information of an individual application LCM operation occurrence
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1637 
      operationId: appLcmOpOccsbyIdOnMm3GET
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1638 1639 1640 1641 1642 1643 1644 1645 
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1646 1647 
      responses:
        '200':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1648 1649 
          description: Information about an application LCM operation occurrence was read successfully
          headers: {}
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1650 1651 1652 
          content:
            application/json:
              schema:
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1653 
                $ref: '#/components/schemas/AppLcmOpOcc'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1654 
        '400':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1655 1656 1657 1658 1659 1660 
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1661 
        '401':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1662 1663 1664 1665 1666 1667 
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1668 
        '403':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1669 1670 1671 1672 1673 1674 
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1675 
        '404':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1676 1677 1678 1679 1680 1681 
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1682 
        '406':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1683 1684 1685 1686 1687 1688 
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1689 
        '429':
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1690 1691 1692 1693 1694 1695 1696 1697 
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1698 1699 1700 1701 1702 1703 
  /app_lcm_op_occs/{appLcmOpOccId}/cancel:
    post:
      tags:
      - 'app-lcm'
      summary: 'cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.'
      description: cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1704 
      operationId: appLcmCancelOnMm3POST
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1705 1706 1707 1708 1709 1710 1711 
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1712 
          type: string
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1713 1714 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 
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelMode'
        required: true
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed.
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/fail:
    post:
      tags:
      - 'app-lcm'
      summary: marks an application lifecycle management operation occurrence as "finally failed"
      description: marks an application lifecycle management operation occurrence as "finally failed"
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1782 
      operationId: appLcmFailOnMm3POST
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1783 1784 1785 1786 1787 1788 1789 
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1790 
          type: string
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 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 
      responses:
        '202':
          description: Shall be returned when the state of the application lifecycle management operation occurrence has been changed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLcmOpOcc'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1850
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1851 1852 1853 1854 1855 1856 
  /app_lcm_op_occs/{appLcmOpOccId}/retry:
    post:
      tags:
      - 'app-lcm'
      summary: initiate retrying an application lifecycle operation that has experience a temporary failure
      description: initiate retrying an application lifecycle operation that has experience a temporary failure
piscione's avatar
Added paths defined from clause 7.7.7 to 7.7.13 for MEC010p2 v2.2.1. Since the...  
piscione committed
1857 
      operationId: appLcmRetryOnMm3POST
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1858 1859 1860 1861 1862 1863 1864 
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
piscione's avatar
Replaced OAS3.0 files with OAS3.1 files.  
piscione committed
1865 
          type: string
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
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 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []


components:
  schemas:
    AppLcmOpOcc:
      title: AppLcmOpOcc
      required:
      - id
      - operationState
      - stateEnteredTime
      - startTime
      - lcmOperation
      - _links
      type: object
      properties:
        id:
          type: string
          description: "'Identifier of the subscription to application LCM operation occurrence notification'"
        operationState:
          $ref: '#/components/schemas/OperationState'
        stateEnteredTime:
          $ref: '#/components/schemas/TimeStamp'
        startTime:
          $ref: '#/components/schemas/TimeStamp'
        lcmOperation:
          $ref: '#/components/schemas/LcmOperation'
        operationParams:
          $ref: '#/components/schemas/OperationParams'
        isCancelPending:
          type: boolean
          description: If the application LCM operation occurrence operationState is in "PROCESSING" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.
        cancelMode:
          $ref: '#/components/schemas/CancelMode'

        _links:
          $ref: '#/components/schemas/AppInstanceLcmOpOcc.links'
      description: "'This data type represents an application lifecycle management operation occurrence'"
    
    AppInstanceSubscriptionLinkList:
      required:
        - _links
      properties:
        _links:
          $ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links'

    AppInstanceSubscriptionLinkList._links:
      required:
        - self
      type: object
      properties:
          self:
            type: string
            description: URI referring to a resource
          subscriptions:
            type: array
            items:
              $ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links.subscriptions'

    AppInstanceSubscriptionLinkList._links.subscriptions:
      type: object
      required:
        - href
        - subscriptionType
      properties:
            href:
              type: uri
            subscriptionType:
              $ref: '#/components/schemas/AppInstanceSubscriptionType'


    AppInstanceSubscriptionType:
Elian Kraja's avatar
MEC010-2 OAS drafts
Elian Kraja committed
1993 
      type: string
piscione's avatar
Updated MEC010p2 OAS from v2.1.1 to v2.1.1  
piscione committed
1994 1995 1996 1997 1998 1999 2000 
      description: String representing the type of a subscription.
      enum:
          - AppInstanceStateChangeSubscription
          - AppLcmOpOccStateChangeSubscription
          - AppIdentifierCreationSubscription
          - AppIdentifierDeletionSubscription
Show full blame