VNFPackageManagement.yaml 52.8 KB
Newer Older
1001
      description: >
rameshnaraya's avatar
rameshnaraya committed
1002
1003
1004
1005
1006
        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.
        This method shall follow the provisions specified in the 
        Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
1007
1008
1009
1010
1011
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
1012
          description: >
rameshnaraya's avatar
rameshnaraya committed
1013
            Attribute-based filtering parameters according to clause 4.3.2.
1014
1015
1016
            The NFVO shall support receiving filtering parameters as part of the URI query
            string. The OSS/BSS may supply filtering parameters.
            All attribute names that appear in the PkgmSubscription and in data types
rameshnaraya's avatar
rameshnaraya committed
1017
            referenced from it shall be supported in attribute-based filtering parameters            
1018
1019
1020
1021
1022
1023
1024
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
        - 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
1039
1040
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1041
          description: >
1042
            200 OK
1043

rameshnaraya's avatar
rameshnaraya committed
1044
            Active subscriptions of the functional block that invokes the method.
1045
1046
1047
1048
1049
1050
1051
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1052
              type: "string"
1053
1054
              description: >
                Challenge if the corresponding HTTP request has not provided
1055
1056
1057
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1058
              minimum: 0
1059
1060
1061
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
1062
1063
              properties:
                PkgmSubscription:
1064
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1083
1084
1085
1086

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
1087
  '/subscriptions/{subscriptionId}':
1088
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by
          the "Location" HTTP header in the response to a POST request
          creating a new subscription resource. It can also be retrieved from
          the "id" attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
1101
      summary: Read an individual subscription resource.
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
      description: >
        Query Subscription Information
        The GET method reads an individual subscription.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1122
          description: >
1123
            200 OK
1124

1125
1126
1127
1128
1129
1130
1131
1132
            Representation of the subscription resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1133
              type: "string"
1134
1135
              description: >
                Challenge if the corresponding HTTP request has not provided
1136
1137
1138
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1139
              minimum: 0
1140
          schema:
rameshnaraya's avatar
rameshnaraya committed
1141
            properties:
1142
              PkgmSubscription:
1143
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    delete:
1163
      summary: Terminate a subscription.
1164
      description: >
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
        The DELETE method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
1176
          description: >
1177
            No Content
1178
1179
1180
1181

            The subscription resource was deleted successfully.
          headers:
            WWW-Authenticate:
1182
              type: "string"
1183
1184
              description: >
                Challenge if the corresponding HTTP request has not provided
1185
1186
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
              maximum: 1
              minimum: 0
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
rameshnaraya's avatar
rameshnaraya committed
1205
1206
1207
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1208
1209
1210
1211
1212
  ##################################################################################
  # Notification endpoint                                                          #
  # Dummy URI is used for testing.                                                 #
  # In real, resource URI is provided by the client when creating the subscription.#
  ##################################################################################
1213
1214
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.10
rameshnaraya's avatar
rameshnaraya committed
1215
    post:
1216
      summary: Notify about VNF package onboarding or change
rameshnaraya's avatar
rameshnaraya committed
1217
1218
1219
1220
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
1221
        request and response data structures, and response codes.        
rameshnaraya's avatar
rameshnaraya committed
1222
1223
1224
      parameters:
        - name: VnfPackageOnboardingNotification
          description: >
1225
            A notification about on-boarding of a VNF package.
rameshnaraya's avatar
rameshnaraya committed
1226
1227
1228
1229
1230
          in: body
          required: true
          schema:
            properties:
              VnfPackageOnboardingNotification:
1231
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageOnboardingNotification"
rameshnaraya's avatar
rameshnaraya committed
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
1256
            204 No Content
1257

1258
1259
1260
1261
1262
1263
1264
1265
1266
            The notification was delivered successfully.  
          headers:
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1267
              minimum: 0
rameshnaraya's avatar
rameshnaraya committed
1268
1269
1270
1271
1272
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1273
          $ref: "responses/SOL005_resp.yaml#/responses/403"
rameshnaraya's avatar
rameshnaraya committed
1274
1275
1276
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1277
1278
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1279
1280
1281
1282
1283
1284
1285
1286
1287
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.10  
    post:
      summary: Notify about VNF package onboarding or change
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
1288
      parameters:
1289
1290
1291
1292
1293
1294
1295
1296
        - name: VnfPackageChangeNotification
          description: >
            A notification about changes of status in a VNF package.
          in: body
          required: true
          schema:
            properties:
              VnfPackageChangeNotification:
1297
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageChangeNotification"
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
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 No Content
1323

1324
1325
1326
1327
1328
1329
1330
1331
1332
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1333
              minimum: 0
1334
1335
1336
1337
1338
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1339
          $ref: "responses/SOL005_resp.yaml#/responses/403"
1340
1341
1342
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1343
1344
          $ref: "responses/SOL005_resp.yaml#/responses/503"

rameshnaraya's avatar
rameshnaraya committed
1345
    get:
1346
      summary: Test the notification endpoint
rameshnaraya's avatar
rameshnaraya committed
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
      description: >
        The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during
        subscription.
        This method shall follow the provisions specified in the Tables 9.4.10.3.2-1 and 9.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
          description: >
1370
            204 No Content
1371

rameshnaraya's avatar
rameshnaraya committed
1372
1373
1374
1375
1376
1377
1378
            The notification endpoint was tested successfully.
            The response body shall be empty. 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1379
          $ref: "responses/SOL005_resp.yaml#/responses/403"
rameshnaraya's avatar
rameshnaraya committed
1380
1381
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
1382
1383
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
For faster browsing, not all history is shown. View entire blame