diff --git a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml index aaeffed5124e51a8cd2b01f264e286d0bed207eb..f9f8f2616821431c1072984adeb597ce5af9d110 100644 --- a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml @@ -18,8 +18,8 @@ info: version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vnffm/v1 @@ -39,10 +39,7 @@ paths: #SOL003 location: 7.4.2 get: description: | - Get Alarm List. - The API consumer can use this method to retrieve information about the alarm list. - This method shall follow the provisions specified in the tables 7.4.2.3.2-1 and 7.4.2.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method to retrieve information about the alarm list. See clause 7.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -85,9 +82,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - The API consumer can use this method to read an individual alarm. - This method shall follow the provisions specified in the tables 7.4.3.3.2-1 and 7.4.3.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method to read an individual alarm. See clause 7.4.3.3.2. responses: 200: $ref: '#/components/responses/IndividualAlarm.Get.200' @@ -114,10 +109,7 @@ paths: patch: description: | - Acknowledge Alarm. - This method modifies an "Individual alarm" resource. - This method shall follow the provisions specified in the tables 7.4.3.3.4-1 and 7.4.3.3.4-2 - for URI query parameters, request and response data structures, and response codes. + This method modifies an "Individual alarm" resource. See clause 7.4.3.3.4. requestBody: $ref: '#/components/requestBodies/IndividualAlarmRequest' responses: @@ -167,20 +159,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Subscribe. - The POST method creates a new subscription. - This method shall follow the provisions specified in the tables 7.4.4.3.1-1 and 7.4.4.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual subscription" resource - as defined in clause 7.4.5 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callback URI and the same filter - can result in performance degradation and will provide duplicates of notifications to the NFVO, - and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating - a new "Individual subscription" resource if another "Individual subscription" resource with the - same filter and callback URI already exists (in which case it shall return the "201 Created" response code), - or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return - a "303 See Other" response code referencing the existing "Individual subscription" resource with the - same filter and callback URI). + The POST method creates a new subscription. See clause 7.4.4.3.1. requestBody: $ref: '#/components/requestBodies/FmSubscriptionRequest' responses: @@ -222,12 +201,8 @@ paths: get: description: | - Query Subscription Information - - - The API consumer can use this method to retrieve the list of active - subscriptions for VNF alarms subscribed by the API consumer. It can be used - e.g. for resynchronization after error situations. + The API consumer can use this method to retrieve the list of active subscriptions for VNF alarms subscribed + by the API consumer. It can be used e.g. for resynchronization after error situations. See clause 7.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker @@ -266,11 +241,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: description: | - Query Subscription Information. - The API consumer can use this method for reading an individual subscription for VNF alarms - subscribed by the API consumer. - This method shall follow the provisions specified in the tables 7.4.5.3.2-1 and 7.4.5.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method for reading an individual subscription for VNF + alarms subscribed by the API consumer. See clause 7.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -300,16 +272,7 @@ paths: delete: description: | - Terminate Subscription. - This method terminates an individual subscription. - This method shall follow the provisions specified in the tables 7.4.5.3.5-1 and 7.4.5.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual subscription" resource - shall not exist any longer. This means that no notifications for that subscription shall be - sent to the formerly-subscribed API consumer. - - NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed - API consumer for a certain time period after the deletion. + This method terminates an individual subscription. See clause 7.4.5.3.5. responses: 204: $ref: '#/components/responses/IndividualSubscription.Delete.204' diff --git a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index b2752a0fa089655036bea4e0757b6a9f2feb5ab3..0efa8b1ddd6b36d30a537975bd3440771a4ae081 100644 --- a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -18,8 +18,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/callback/v1 @@ -36,11 +36,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method notifies a VNF alarm or that the alarm list has been rebuilt. - The API consumer shall have previously created an "Individual subscription resource" with a matching filter. - This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -65,10 +62,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. - This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the + API consumer, e.g. during subscription. See clause 7.4.6.3.2. responses: 204: $ref: '#/components/responses/AlarmNotification.Get.204' @@ -97,11 +92,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method notifies a VNF alarm or that the alarm list has been rebuilt. - The API consumer shall have previously created an "Individual subscription resource" with a matching filter. - This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -126,10 +118,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. - This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the + API consumer, e.g. during subscription. See clause 7.4.6.3.2. responses: 204: $ref: '#/components/responses/AlarmClearedNotification.Get.204' @@ -158,11 +148,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method notifies a VNF alarm or that the alarm list has been rebuilt. - The API consumer shall have previously created an "Individual subscription resource" with a matching filter. - This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -187,10 +174,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. - This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the + API consumer, e.g. during subscription. See clause 7.4.6.3.2. responses: 204: $ref: '#/components/responses/AlarmListRebuiltNotification.Get.204' diff --git a/src/SOL003/VNFIndicator/VNFIndicator.yaml b/src/SOL003/VNFIndicator/VNFIndicator.yaml index cef0b8a04cdb1e579de868e638acd5527452230d..d2d037e9efec44be68bd3434e728f300f71df0b7 100644 --- a/src/SOL003/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL003/VNFIndicator/VNFIndicator.yaml @@ -18,8 +18,8 @@ info: version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vnfind/v1 @@ -40,10 +40,7 @@ paths: #SOL003 location: 8.4.2 get: description: | - Get Indicator Value. - The GET method queries multiple VNF indicators. - This method shall follow the provisions specified in the tables 8.4.2.3.2-1 and 8.4.2.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method queries multiple VNF indicators. See clause 8.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -83,10 +80,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' get: description: | - Get Indicator Value. - The GET method queries multiple VNF indicators related to a VNF instance. - This method shall follow the provisions specified in the tables 8.4.3.3.2-1 and 8.4.3.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method queries multiple VNF indicators related to a VNF instance. See clause 8.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -128,10 +122,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' get: description: | - Get Indicator Value. - The GET method reads a VNF indicator. - This method shall follow the provisions specified in the tables 8.4.4.3.2-1 and 8.4.4.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method reads a VNF indicator. See clause 8.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -172,20 +163,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Subscribe. - The POST method creates a new subscription. - As the result of successfully executing this method, a new "Individual subscription" resource - as defined in clause 8.4.6 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callback URI and the same filter - can result in performance degradation and will provide duplicates of notifications to the NFVO, - and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating - a new "Individual subscription" resource if another "Individual subscription" resource with the - same filter and callback URI already exists (in which case it shall return the "201 Created" response code), - or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return - a "303 See Other" response code referencing the existing "Individual subscription" resource with the same - filter and callback URI). - This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method creates a new subscription. See clause 8.4.5.3.1. requestBody: $ref: '#/components/requestBodies/VnfIndicatorSubscriptionRequest' responses: @@ -227,11 +205,8 @@ paths: get: description: | - Query Subscription Information. - 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 8.4.5.3.2-1 and 8.4.5.3.2-2 - for URI query parameters, request and response data structures, and response codes. + 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. See clause 8.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker @@ -271,10 +246,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - Query Subscription Information. - The GET method reads an individual subscription. - This method shall follow the provisions specified in the tables 8.4.6.3.2-1 and 8.4.6.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method reads an individual subscription. See clause 8.4.6.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -303,16 +275,7 @@ paths: delete: description: | - Terminate Subscription. - The DELETE method terminates an individual subscription. - This method shall follow the provisions specified in the tables 8.4.6.3.5-1 and 8.4.6.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual subscription" resource - shall not exist any longer. This means that no notifications for that subscription shall be - sent to the formerly-subscribed API consumer. - - NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed - API consumer for a certain time period after the deletion. + The DELETE method terminates an individual subscription. See clause 8.4.6.3.5. responses: 204: $ref: '#/components/responses/IndividualSubscription.Delete.204' diff --git a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml index cbf33e42b8231a087fa0ffa9cc7f1e8f18ddfcb5..296725d5c066a71d4ae6925ce7ca82be768980e2 100644 --- a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -18,8 +18,8 @@ info: version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/callback/v1 @@ -33,11 +33,8 @@ paths: #SOL003 location: 8.4.7 post: description: | - Notify. - The POST method delivers a notification from the API producer to an API consumer. - The API consumer shall have previously created an "Individual subscription resource" with a matching filter. - This method shall follow the provisions specified in the tables 8.4.7.3.1-1 and 8.4.7.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method delivers a notification from the API producer to an API consumer. The API consumer shall + have previously created an "Individual subscription" resource with a matching filter. See clause 8.4.7.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version @@ -63,10 +60,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by - the API consumer, e.g. during subscription. - This method shall follow the provisions specified in the tables 8.4.7.3.2-1 and 8.4.7.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. See clause 8.4.7.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version diff --git a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml index dccf496556ada8d7e91017331d322c0af465a9b6..c0ed1bdbc51dcc4649f0bef3c4416934090c01c9 100644 --- a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -18,8 +18,8 @@ info: version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vnflcm/v1 @@ -43,25 +43,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - The POST method creates a new VNF instance resource based on a VNF package that is onboarded and in - "ENABLED" state. - This method shall follow the provisions specified in the tables 5.4.2.3.1-1 and 5.4.2.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual VNF instance" - resource as defined in clause 5.4.3 shall have been created, and the value of the - "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". - A notification of type VnfIdentifierCreationNotification shall be triggered as part of successfully - executing this method as defined in clause 5.5.2.18. - When initiating the creation of a VNF instance resource, the passed metadata values can differ from - the default values for metadata, if any, declared in the VNFD. - The VNFM shall apply the "metadata" attributes in the "CreateVnfRequest" data structure in the payload - body to the "metadata" attribute in the "VnfInstance" data structure on top of the default values that - were obtained from the VNFD according to the rules of JSON Merge Patch (see IETF RFC 7396). - For all metadata keys defined in the VNFD, the VNFM shall ensure that the content of the resulting - "metadata" attributes is valid against the data type definitions in the VNFD. The absence of a metadata - item that is marked "required" in the VNFD shall not be treated as an error. In case a "metadata" child - attribute is not defined in the VNFD, the VNFM shall consider it valid in case it is a valid JSON structure. - In case of an error, the operation shall be rejected with a "422 Unprocessable Entity" error. + The POST method creates a new VNF instance resource based on a VNF package that is onboarded + and in "ENABLED" state. See clause 5.4.2.3.1. requestBody: $ref: '#/components/requestBodies/CreateVnfRequest' responses: @@ -90,8 +73,7 @@ paths: get: description: | - Query VNF. - The GET method queries information about multiple VNF instances. + The GET method queries information about multiple VNF instances. See clause 5.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields @@ -134,11 +116,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - Query VNF. - The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource. - This method shall follow the provisions specified in the tables 5.4.3.3.2-1 and 5.4.3.3.2-2 - for URI query parameters, request and response data structures, and response codes. + See clause 5.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -168,47 +147,7 @@ paths: patch: #SOL003 location: 5.4.3.3.4 description: | - Modify VNF Information. - This method modifies an "Individual VNF instance" resource. - Changes to the VNF configurable properties are applied to the configuration in the VNF instance, - and are reflected in the representation of this resource. - Other changes are applied to the VNF instance information managed by the VNFM, and are reflected - in the representation of this resource. - This method shall follow the provisions specified in the tables 5.4.3.3.4-1 and 5.4.3.3.4-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method are - specified in clause 5.4.1.2. - - The VNFM shall apply the "metadata", "extensions" and "vnfConfigurableProperties" attributes in the - "VnfInfoModificationRequest" data structure in the payload body to the existing "extensions" and - "vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the - rules of JSON Merge Patch (see IETF RFC 7396). - The VNFM shall ensure that the content of the child attributes of the resulting "metadata", "extensions" - and "vnfConfigurableProperties" attributes is valid against the data types definitions of these child - attributes in the VNFD. - - In case a "metadata" child attribute is not defined in the VNFD, the VNFM shall consider it valid in - case it is a valid JSON structure. - - NOTE: "Extensions" and "vnfConfigurableProperties" child attributes are always declared in the VNFD. - - If the VNF instance is in the "INSTANTIATED" state, the validation shall also include - ensuring the presence of all "extensions" and "vnfConfigurableProperties" child attributes that are - marked as "required" in the VNFD. - - NOTE: This allows to build the set of "extensions" and "vnfConfigurableProperties" incrementally - prior VNF instantiation but ensures their completeness for an instantiated VNF instance. - - The absence of a metadata item that is marked "required" in the VNFD shall not be treated as an error. - - In case of an error during validation, the operation shall be automatically rolled back, and - appropriate error information shall be provided in the "VnfLcmOperationOccurrenceNotification" - message and the "VnfLcmOpOcc" data structure. - The processing of changes to the "metadata" / "extensions" / "vnfConfigurableProperties" attributes - shall be performed in the "PROCESSING" phase of the LCM operation. The change shall be atomic, i.e. the - result of intermediate stages shall not be visible in the API. In case of successful completion of the - processing and validation, the attributes shall be provided in the "VnfInstance" data structure and - the operation shall proceed towards successful completion. + This method modifies an "Individual VNF instance" resource. See clause 5.4.3.3.4. requestBody: $ref: '#/components/requestBodies/VnfInfoModificationRequest' responses: @@ -244,14 +183,7 @@ paths: delete: #SOL003 location: 5.4.3.3.5 description: | - Delete VNF Identifier. - This method deletes an "Individual VNF instance" resource. - This method shall follow the provisions specified in the tables 5.4.3.3.5-1 and 5.4.3.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual VNF instance" resource - shall not exist any longer. - A notification of type "VnfIdentifierDeletionNotification" shall be triggered as part of successfully - executing this method as defined in clause 5.5.2.19. + This method deletes an "Individual VNF instance" resource. See clause 5.4.3.3.5. responses: 204: $ref: '#/components/responses/IndividualVnfInstance.Delete.204' @@ -292,32 +224,7 @@ paths: post: #SOL003 location: 5.4.4.3.1 description: | - Instantiate VNF. - The POST method instantiates a VNF instance. - This method shall follow the provisions specified in the tables 5.4.4.3.1-1 and 5.4.4.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, - it shall set the "instantiationState" attribute to the value "INSTANTIATED" and the "vnfState" - attribute to the value "STARTED" in the representation of the "Individual VNF instance" resource. - - When instantiating a VNF instance, the values of the extensions and/or VNF configurable properties - passed in the instantiation request can differ from the values in the "VnfInstance" data structure - that were initialized from default values, if any, declared in the VNFD. - The VNFM shall apply the "extensions" and "vnfConfigurableProperties" attributes in the - "InstantiateVnfRequest" data structure in the payload body to the existing "extensions" and - "vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the rules - of JSON Merge Patch (see IETF RFC 7396). The VNFM shall ensure that the content of the resulting - "extensions" and "vnfConfigurableProperties" attributes is valid against the VNFD (including the - presence of all child attributes that are marked as "required" in the VNFD). In case of an error - during validation, the operation shall be automatically rolled back, and appropriate error information - shall be provided in the "VnfLcmOperationOccurrenceNotification" message and the "VnfLcmOpOcc" - data structure. The processing of changes to the "extensions" / "vnfConfigurableProperties" attributes - shall be performed in the "STARTING" phase of the LCM operation. The change shall be atomic, i.e. - the result of intermediate stages shall not be visible in the API. In case of successful completion - of the processing and validation, the attributes shall be provided in the "VnfInstance" data structure - and the operation shall proceed to obtain the grant. + The POST method instantiates a VNF instance. See clause 5.4.4.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -368,15 +275,7 @@ paths: post: #SOL003 location: 5.4.5.3.1 description: | - Scale VNF. - The POST method requests to scale a VNF instance resource incrementally. - This method shall follow the provisions specified in the tables 5.4.5.3.1-1 and 5.4.5.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method are - specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, - it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute - in the representation of the "Individual VNF instance" resource. + The POST method requests to scale a VNF instance resource incrementally. See clause 5.4.5.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -436,15 +335,7 @@ paths: post: #SOL003 location: 5.4.6.3.1 description: | - Scale VNF to Level. - The POST method requests to scale a VNF instance resource to a target level. - This method shall follow the provisions specified in the tables 5.4.6.3.1-1 and 5.4.6.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method are - specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, - it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute - in the representation of the "Individual VNF instance" resource. + The POST method requests to scale a VNF instance resource to a target level. See clause 5.4.6.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -503,31 +394,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - Change VNF Flavour. - This method shall follow the provisions specified in the tables 5.4.7.3.1-1 and 5.4.7.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, - it shall set the "flavourId" attribute in the representation of the "Individual VNF instance" - resource to the value of the "newFlavourId" attribute passed in the "ChangeVnfFlavourRequest" - data in the POST request. - - When initiating a change of the current VNF flavour, the values of the extensions and/or VNF - configurable properties, can differ between the new flavour and the old flavour of the VNF instance. - The VNFM shall apply the "extensions" and "vnfConfigurableProperties" attributes in the - "ChangeVnfFlavourRequest" data structure in the payload body to the existing "extensions" and - "vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the rules - of JSON Merge Patch (see IETF RFC 7396). The VNFM shall ensure that the content of the resulting - "extensions" and "vnfConfigurableProperties" attributes is valid against the VNFD (which includes - ensuring the presence of all child attributes that are marked as "required" in the VNFD). In case - of an error, the operation shall be automatically rolled back, and appropriate error information - shall be provided in the "VnfLcmOperationOccurrenceNotification" message and the "VnfLcmOpOcc" data - structure. The processing of changes to the "extensions" / "vnfConfigurableProperties" attributes - shall be performed in the "STARTING" phase of the LCM operation. The change shall be atomic, i.e. - the result of intermediate stages shall not be visible in the API. In case of successful completion - of the processing and validation, the attributes shall be provided in the "VnfInstance" data structure - and the operation shall proceed to obtain the grant. + The POST method changes the deployment flavour of a VNF instance. See clause 5.4.7.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -586,16 +453,8 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - Terminate VNF. - The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM - the release of its used virtualised resources. - This method shall follow the provisions specified in the tables 5.4.8.3.1-1 and 5.4.8.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, - it shall set the "instantiationState" attribute in the representation of the "Individual VNF instance" - resource to the value "NOT_INSTANTIATED". + The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM the + release of its used virtualised resources. See clause 5.4.8.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -644,12 +503,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - Heal VNF. - The POST method requests to heal a VNF instance. - This method shall follow the provisions specified in the tables 5.4.9.3.1-1 and 5.4.9.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. + The POST method requests to heal a VNF instance. See clause 5.4.9.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -708,15 +562,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - Operate VNF. - The POST method changes the operational state of a VNF instance resource. - This method shall follow the provisions specified in the tables 5.4.10.3.1-1 and 5.4.10.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, - it shall set the "vnfState" attribute in the representation of the "Individual VNF instance" resource - to the value of the "changeStateTo" attribute passed in the "OperateVnfRequest" data in the POST request. + The POST method changes the operational state of a VNF instance. See clause 5.4.10.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -775,12 +621,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - Change External VNF Connectivity. - The POST method changes the external connectivity of a VNF instance. - This method shall follow the provisions specified in the tables 5.4.11.3.1-1 and 5.4.11.3.1-2 - for URI query parameters, request and response data structures, and response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. + The POST method changes the external connectivity of a VNF instance. See clause 5.4.11.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -828,15 +669,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - The POST method changes the current VNF package on which the VNF instance is based. - This method shall follow the provisions specified in the tables 5.4.11a.3.1-1 and - 5.4.11a.3.1-2 for URI query parameters, request and response data structures, and - response codes. - The steps and conditions that apply as the result of successfully executing this method - are specified in clause 5.4.1.2. - During a change of the current VNF package, the allowed and required extensions and/or - VNF configurable properties and their data types, as well as the metadata data types, - can differ between the source and the destination VNFD. + The POST method changes the current VNF package on which the VNF instance is based. See clause 5.4.11a.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -882,11 +715,8 @@ paths: #SOL003 location: 5.4.12 get: description: | - Get Operation Status. - The API consumer can use this method to query status information about multiple - VNF lifecycle management operation occurrences. - This method shall follow the provisions specified in the tables 5.4.12.3.2-1 and 5.4.12.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method to query status information about multiple VNF lifecycle management + operation occurrences. See clause 5.4.12.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -947,11 +777,8 @@ paths: - $ref: '#/components/parameters/VnfLcmOpOccId' get: description: | - Get Operation Status. - The API consumer can use this method to retrieve status information about a VNF lifecycle - management operation occurrence by reading an "Individual VNF LCM operation occurrence" resource. - This method shall follow the provisions specified in the tables 5.4.13.3.2-1 and 5.4.13.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method to retrieve status information about a VNF lifecycle management operation + occurrence by reading an "Individual VNF LCM operation occurrence" resource. See clause 5.4.13.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -987,15 +814,9 @@ paths: - $ref: '#/components/parameters/VnfLcmOpOccId' post: description: | - The POST method initiates retrying a VNF lifecycle operation if that operation - has experienced a temporary failure, i.e. the related "Individual VNF LCM operation occurrence" - resource is in "FAILED_TEMP" state. - This method shall follow the provisions specified in the tables 5.4.14.3.1-1 and 5.4.14.3.1-2 - for URI query parameters, request and response data structures, and response codes. - In case of success of processing the asynchronous request, the "operationState" attribute - in the representation of the parent resource shall be changed to "PROCESSING" and the applicable - "start" notification according to clause 5.6.2.2 shall be emitted to indicate that the underlying - VNF LCM operation occurrence proceeds. + The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary + failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state. + See clause 5.4.14.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version @@ -1049,19 +870,9 @@ paths: - $ref: '#/components/parameters/VnfLcmOpOccId' post: description: | - The POST method initiates rolling back a VNF lifecycle operation if that operation - has experienced a temporary failure, i.e. the related "Individual VNF LCM operation occurrence" - resource is in "FAILED_TEMP" state. - In case of rolling back an occurrence of the "InstantiateVnf" operation, the VNFM shall - request to the VIM the release of the virtualised resources that were allocated for the related VNF instance. - The "rollback" task shall be supported by the VNFM for any VNF LCM operation occurrence that represents an - "InstantiateVnf" operation in FAILED_TEMP state. - This method shall follow the provisions specified in the tables 5.4.15.3.1-1 and 5.4.15.3.1-2 - for URI query parameters, request and response data structures, and response codes. - In case of success of processing the asynchronous request, the "operationState" attribute - in the representation of the parent resource shall be changed to "ROLLING_BACK" and the applicable - "start" notification according to clause 5.6.2.2 shall be emitted to indicate that rollback of the - underlying VNF LCM operation occurrence is attempted. + The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary + failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state. + See clause 5.4.15.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version @@ -1115,14 +926,8 @@ paths: - $ref: '#/components/parameters/VnfLcmOpOccId' post: description: | - The POST method marks a VNF lifecycle management operation occurrence as "finally failed" - if that operation occurrence is in "FAILED_TEMP" state. - This method shall follow the provisions specified in the tables 5.4.16.3.1-1 and 5.4.16.3.1-2 - for URI query parameters, request and response data structures, and response codes. - In case of success, the "operationState" attribute in the representation of the parent resource - shall be changed to "FAILED" and the applicable "result" notification according to clause 5.6.2.2 - shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence - has finally and unrecoverably failed. + The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation + occurrence is in "FAILED_TEMP" state. See clause 5.4.16.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -1177,30 +982,9 @@ paths: - $ref: '#/components/parameters/VnfLcmOpOccId' post: description: | - The POST method initiates cancelling an ongoing VNF lifecycle operation while - it is being executed or rolled back, i.e. the related "Individual VNF LCM operation occurrence" - resource is either in "STARTING" or "PROCESSING" or "ROLLING_BACK" state. - This method shall follow the provisions specified in the tables 5.4.17.3.1-1 and 5.4.17.3.1-2 - for URI query parameters, request and response data structures, and response codes. - Before returning the "202 Accepted" response, the VNFM shall update the "isCancelPending" - and "cancelMode" attributes in the representation of the parent resource according to the - provisions in clause 5.5.2.13. - - In case of success of processing the asynchronous request: - 1) If the request has been processed in "STARTING" state, the "operationState" attribute - in the representation of the parent resource shall be changed to "ROLLED_BACK". - 2) If the request has been processed in "PROCESSING" or "ROLLING_BACK" state, - the "operationState" attribute in the representation of the parent resource - shall be changed to "FAILED_TEMP". - - In both cases, the VNFM shall update the "isCancelPending" and "cancelMode" attributes - in the representation of the parent resource according to the provisions in clause 5.5.2.13 - to reflect the new status, and the applicable "result" notification according to clause 5.6.2.2 - shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence - has temporarily failed. - Due to race conditions, the processing of the actual operation that is to be cancelled may eventually - still succeed, in which case the "operationState" attribute in the representation of the parent - resource shall represent the result of that operation, rather than the result of the cancellation. + The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled + back, i.e. the related "Individual VNF LCM operation occurrence" resource is either in "STARTING" or + "PROCESSING" or "ROLLING_BACK" state. See clause 5.4.17.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version @@ -1246,20 +1030,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Subscribe. - The POST method creates a new subscription. - This method shall follow the provisions specified in the tables 5.4.18.3.1-1 and 5.4.18.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual subscription" - resource as defined in clause 5.4.3 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callback URI and the same filter - can result in performance degradation and will provide duplicates of notifications to the NFVO, - and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating - an "Individual subscription" resource if another "Individual subscription" resource with the same - filter and callback URI already exists (in which case it shall return the "201 Created" response code), - or may decide to not create a duplicate "Individual subscription" resource (in which case it shall - return a "303 See Other" response code referencing the existing "Individual subscription" resource - with the same filter and callback URI). + The POST method creates a new subscription. See clause 5.4.18.3.1. requestBody: $ref: '#/components/requestBodies/LccnSubscriptionRequest' responses: @@ -1297,10 +1068,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: description: | - Query Subscription Information. - 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. + 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. See clause 5.4.18.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker @@ -1337,10 +1106,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - Query Subscription Information. The GET method retrieves information about a subscription by reading an "Individual subscription" resource. - This method shall follow the provisions specified in the tables 5.4.19.3.2-1 and 5.4.19.3.2-2 - for URI query parameters, request and response data structures, and response codes. + See clause 5.4.19.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -1367,17 +1134,7 @@ paths: delete: description: | - Terminate Subscription. - The DELETE method terminates an individual subscription. - This method shall follow the provisions specified in the tables 5.4.19.3.5-1 and 5.4.19.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual subscription" resource - shall not exist any longer. This means that no notifications for that subscription shall be - sent to the formerly-subscribed API consumer. - - NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed - - API consumer for a certain time period after the deletion. + The DELETE method terminates an individual subscription. See clause 5.4.19.3.5. responses: 204: $ref: '#/components/responses/IndividualSubscription.Delete.204' @@ -1409,19 +1166,8 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - The POST method requests taking a snapshot a VNF instance and populating a - previously created VNF snapshot resource (refer to clause 5.4.23.3.1) with - the snapshot content. - The steps and conditions that apply as the result of successfully executing - this method are specified in clause 5.4.1.2. - In addition, once the VNFM has successfully completed the underlying VNF LCM - operation occurrence, it shall reflect the result of the VNF snapshot creation - by updating the corresponding "Individual VNF snapshot" resource indicated by - the "vnfSnapshotInfoId" attribute of the "CreateVnfSnapshotRequest" that is - included in the payload body of the request. - This method shall follow the provisions specified in the tables 5.4.21.3.1-1 - and 5.4.21.3.1-2 for URI query parameters, request and response data structures, - and response codes. + The POST method requests taking a snapshot a VNF instance and populating a previously created VNF snapshot + resource (refer to clause 5.4.23.3.1) with the snapshot content. See clause 5.4.21.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -1484,10 +1230,7 @@ paths: - $ref: '#/components/parameters/VnfInstanceId' post: description: | - The POST method requests reverting a VNF instance to a VNF snapshot. - This method shall follow the provisions specified in the tables 5.4.22.3.1-1 - and 5.4.22.3.1-2 for URI query parameters, request and response data structures, - and response codes. + The POST method requests reverting a VNF instance to a VNF snapshot. See clause 5.4.22.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -1550,32 +1293,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - The POST method creates a new "Individual VNF snapshot" resource. - - As a result of successfully executing this method, a new "Individual VNF snapshot" - resource as defined in clause 5.4.24 shall have been created. - - The creation of an "Individual VNF snapshot" resource can be performed for two reasons: - - To create an "Individual VNF snapshot" resources that can later be populated by a - new VNF snapshot taken from a VNF instance (refer to clause 5.4.21.3.1). - - To create an "Individual VNF snapshot" resource that can be populated with information - gathered from a VNF snapshot package extraction. In this case, the API consumer indicates - the source of the VNF snapshot package in the payload body of the POST request to the - present resource. - - In the second case, for a successful execution of the operation, the values in the - "VnfSnapshotInfo" data structure representing the "Individual VNF snapshot" resource - shall be applied as follows: - - If the request (refer to clause 5.5.2.20) includes the "vnfSnapshot" attribute, - the VNFM shall apply the "VnfSnapshotInfo" with such provided information. - - If the request (refer to clause 5.5.2.20) does not include the "vnfSnapshot" - attribute, the VNFM shall first fetch the VNF snapshot record from the source VNF - snapshot package signalled by the "vnfSnapshotPkgId" attribute in the request and - then apply the "VnfSnapshotInfo" from the fetched VNF snapshot record. - - This method shall follow the provisions specified in the tables 5.4.23.3.1-1 - and 5.4.23.3.1-2 for URI query parameters, request and response data structures, - and response codes. + The POST method creates a new "Individual VNF snapshot" resource. See clause 5.4.23.3.1. requestBody: $ref: '#/components/requestBodies/CreateVnfSnapshotInfoRequest' responses: @@ -1650,10 +1368,8 @@ paths: get: #SOL003 location: 5.4.24.3.2 description: | - The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" - resource. - This method shall follow the provisions specified in the tables 5.4.24.3.2-1 and 5.4.24.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" resource. + See clause 5.4.24.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -1683,16 +1399,7 @@ paths: patch: #SOL003 location: 5.4.24.3.4 description: | - This method modifies an "Individual VNF snapshot" resource. - - Changes are applied to the VNF snapshot information managed by the VNFM and are reflected in the - representation of this resource. The VNFM shall reject the modification request if the "vnfSnapshot" - attribute in the "VnfSnapshotInfo" structure representing the "Individual VNF snapshot" resource - is not empty, or the resource is associated to an ongoing VNF snapshot operation (e.g., a VNF - snapshot creation process has started). - - This method shall follow the provisions specified in the tables 5.4.24.3.4-1 and 5.4.24.3.4-2 - for URI query parameters, request and response data structures, and response codes. + This method modifies an "Individual VNF snapshot" resource. See clause 5.4.24.3.4. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -1729,13 +1436,8 @@ paths: delete: #SOL003 location: 5.4.24.3.5 description: | - This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot - information managed by the VNFM, and any resource associated to the VNF snapshot managed - by the VIM. - As the result of successfully executing this method, the "Individual VNF snapshot" resource - shall not exist any longer. - This method shall follow the provisions specified in the tables 5.4.24.3.5-1 and 5.4.24.3.5-2 - for URI query parameters, request and response data structures, and response codes. + This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot information + managed by the VNFM, and any resource associated to the VNF snapshot managed by the VIM. See clause 5.4.24.3.5. responses: 204: $ref: '#/components/responses/IndividualVnfSnapshot.Delete.204' diff --git a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index 829ae34da92f8e3c2642c9f7f1bd2c1831c20de9..3e9298a5f3be3921a6726909b228c57154320756 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -18,8 +18,8 @@ info: version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/callback/v1 @@ -35,11 +35,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method delivers a notification from the API producer to an API consumer. - The API consumer shall have previously created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables 5.4.20.3.1-1 and 5.4.20.3.1-2 for - URI query parameters, request and response data structures, and response codes. + The POST method delivers a notification from the API producer to an API consumer. The API consumer shall + have previously created an "Individual subscription" resource with a matching filter. See clause 5.4.20.3.1. requestBody: $ref: '#/components/requestBodies/VnfLcmOperationOccurrenceNotification' responses: @@ -62,10 +59,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by the - API consumer, e.g. during subscription. - This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. See clause 5.4.20.3.2. responses: 204: $ref: '#/components/responses/VnfLcmOperationOccurrenceNotification.Get.204' @@ -93,11 +88,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method delivers a notification from the API producer to an API consumer. - The API consumer shall have previously created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables 5.4.20.3.1-1 and 5.4.20.3.1-2 for - URI query parameters, request and response data structures, and response codes. + The POST method delivers a notification from the API producer to an API consumer. The API consumer shall + have previously created an "Individual subscription" resource with a matching filter. See clause 5.4.20.3.1. requestBody: $ref: '#/components/requestBodies/VnfIdentifierCreationNotification' responses: @@ -121,9 +113,7 @@ paths: get: description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. - This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2 - for URI query parameters, request and response data structures, and response codes. + e.g. during subscription. See clause 5.4.20.3.2. responses: 204: $ref: '#/components/responses/VnfIdentifierCreationNotification.Get.204' @@ -151,11 +141,8 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method delivers a notification from the API producer to an API consumer. - The API consumer shall have previously created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables 5.4.20.3.1-1 and 5.4.20.3.1-2 for - URI query parameters, request and response data structures, and response codes. + The POST method delivers a notification from the API producer to an API consumer. The API consumer shall + have previously created an "Individual subscription" resource with a matching filter. See clause 5.4.20.3.1. requestBody: $ref: '#/components/requestBodies/VnfIdentifierDeletionNotification' responses: @@ -179,9 +166,7 @@ paths: get: description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. - This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2 - for URI query parameters, request and response data structures, and response codes. + e.g. during subscription. See clause 5.4.20.3.2. responses: 204: $ref: '#/components/responses/VnfIdentifierDeletionNotification.Get.204' diff --git a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml index d30029b2dca41f886fda57cba880248f0b9b7934..a65e4a1abc40c3c6f43e3a84187fe4f1195d256e 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml @@ -18,8 +18,8 @@ info: version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/grant/v1 @@ -39,15 +39,7 @@ paths: #SOL003 location: 9.4.2 post: description: | - Grant Lifecycle Operation. - The POST method requests a grant for a particular VNF lifecycle operation. - This method shall follow the provisions specified in the tables 9.4.2.3.1-1 and 9.4.2.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully processing this request, a new "Individual grant" resource - shall be created. In the synchronous case which is indicated by responding with "201 Created", - that resource shall be created before the 200 OK response is returned. In the asynchronous - case which is indicated by responding with "202 Accepted", this resource may be created - after the response is returned. + The POST method requests a grant for a particular VNF lifecycle operation. See clause 9.4.2.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -93,10 +85,7 @@ paths: - $ref: '#/components/parameters/GrantId' get: description: | - Grant Lifecycle Operation. - The GET method reads a grant. - This method shall follow the provisions specified in the tables 9.4.3.3.2-1 and 9.4.3.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method reads a grant. See clause 9.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization diff --git a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml index 25d7f72d9431b21a8ae468d8bda094ef2d9a3968..e4dbbcdf4980d8d3646b3eee43a8dd50a9fe0110 100644 --- a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml @@ -18,8 +18,8 @@ info: version: "2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vnfpkgm/v2 @@ -39,10 +39,7 @@ paths: #SOL003 location: 10.4.2 get: description: | - Query VNF Package Info. - The GET method queries the information of the VNF packages matching the filter. - This method shall follow the provisions specified in the tables 10.4.2.3.2-1 and 10.4.2.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method queries the information of the VNF packages matching the filter. See clause 10.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -77,6 +74,9 @@ paths: 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + /vnf_packages: + $ref: '#paths/~1onboarded_vnf_packages' + ############################################################################### # Individual VNF package # ############################################################################### @@ -85,11 +85,7 @@ paths: - $ref: '#/components/parameters/VnfPkgId' get: description: | - Query VNF Package Info. - The GET method reads the information of an individual VNF package. - This method shall follow the provisions specified in the tables - 10.4.3.3.2-1 and 10.4.3.3.2-2 for URI query parameters, - request and response data structures, and response codes. + The GET method reads the information of an individual VNF package. Clause 10.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -122,11 +118,7 @@ paths: - $ref: '#/components/parameters/VnfdId' get: description: | - Query VNF Package Info. - The GET method reads the information of an individual VNF package. - This method shall follow the provisions specified in the tables - 10.4.3.3.2-1 and 10.4.3.3.2-2 for URI query parameters, - request and response data structures, and response codes. + The GET method reads the information of an individual VNF package. Clause 10.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -163,94 +155,7 @@ paths: - $ref: '#/components/parameters/VnfPkgId' get: description: | - Query VNF Package Info - - The GET method reads the content of the VNFD within a VNF package. - The VNFD is implemented as a collection of one or more files. - A ZIP archive embedding these files shall be returned when reading this resource. - The default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 - where only the files representing the VNFD and information needed to navigate the ZIP - archive and to identify the file that is the entry point for parsing the VNFD, and, - if requested, further security information are included. This means that the structure - of the ZIP archive shall correspond to the directory structure used in the VNF package - and that the archive shall contain the following files from the package: - • TOSCA.meta (if available in the package) - • The main TOSCA definitions YAML file (either as referenced from TOSCA.meta - or available as a file with the extension ".yml" or ".yaml" from the root of the archive) - • Every component of the VNFD referenced (recursively) from the main TOSCA definitions YAML file - • The related security information, if the "include_signatures" URI parameter is provided, as follows: - - the manifest file - - the singleton certificate file in the root of the VNF package (if available in the package) - - the signing certificates of the individual files included in the ZIP archive (if available in the package) - - the signatures of the individual files (if available in the package) - Three examples are provided below. - - NOTE: These examples do not show the security related files. - - EXAMPLE 1: Assuming a request is sent for the following VNF package - (as described in clause A.1 in ETSI GS NFV-SOL 004): - !------TOSCA-Metadata - !----- TOSCA.meta (metadata for navigating the ZIP file) - !------Definitions - !----- MRF.yaml (main VNFD file) - !----- OtherTemplates (e.g. type definitions, referenced by the main VNFD file) - !------Files - !----- ChangeLog.txt - !----- image(s) - !----- other artifacts - !------Tests - !----- file(s) - !------Licenses - !----- file(s) - !------Scripts - !----- install.sh - !----- MRF.mf - - The NFVO will return a ZIP file of the following format: - !------TOSCA-Metadata - !----- TOSCA.meta - !------Definitions - !----- MRF.yaml - !----- OtherTemplates - - EXAMPLE 2: Assuming a request is sent for the following VNF package - (a VNF package without a TOSCA-Metadata directory, as - described in clause A.2 in ETSI GS NFV-SOL 004): - !------MRF.yaml (main VNFD file) - !------MRF.mf - !------ChangeLog.txt - !------Tests - !----- file(s) - !------Licenses - !----- file(s) - !------Artifacts - !----- install.sh - !----- start.yang - - The NFVO will return a ZIP file of the following format: - !------MRF.yaml - - EXAMPLE 3: Assuming a request is sent for the following VNF package - (a VNF package with the YANG VNFD without a TOSCA-Metadata directory, - as described in clause A.3 in ETSI GS NFV SOL 004): - !----CompanyVNFD.yaml - !----CompanyVNFD.xml - !----CompanyVNFD.mf - !----ChangeLog.txt - !-----Files - !-----Instance Data Files - !---- start.xml - !-----Licenses - !-----Scripts - !----- install.sh - - The NFVO will return a ZIP file of the following format: - !----CompanyVNFD.yaml - !----CompanyVNFD.xml (indicated in the yang_definitions metadata in CompanyVNFD.yaml) - - This method shall follow the provisions specified in the tables 10.4.4.3.2-1 - and 10.4.4.3.2-2 for URI query parameters, request and response data structures, - nd response codes. + The GET method reads the content of the VNFD within a VNF package. See clause 10.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -292,94 +197,7 @@ paths: - $ref: '#/components/parameters/VnfdId' get: description: | - Query VNF Package Info - - The GET method reads the content of the VNFD within a VNF package. - The VNFD is implemented as a collection of one or more files. - A ZIP archive embedding these files shall be returned when reading this resource. - The default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 - where only the files representing the VNFD and information needed to navigate the ZIP - archive and to identify the file that is the entry point for parsing the VNFD, and, - if requested, further security information are included. This means that the structure - of the ZIP archive shall correspond to the directory structure used in the VNF package - and that the archive shall contain the following files from the package: - • TOSCA.meta (if available in the package) - • The main TOSCA definitions YAML file (either as referenced from TOSCA.meta - or available as a file with the extension ".yml" or ".yaml" from the root of the archive) - • Every component of the VNFD referenced (recursively) from the main TOSCA definitions YAML file - • The related security information, if the "include_signatures" URI parameter is provided, as follows: - - the manifest file - - the singleton certificate file in the root of the VNF package (if available in the package) - - the signing certificates of the individual files included in the ZIP archive (if available in the package) - - the signatures of the individual files (if available in the package) - Three examples are provided below. - - NOTE: These examples do not show the security related files. - - EXAMPLE 1: Assuming a request is sent for the following VNF package - (as described in clause A.1 in ETSI GS NFV-SOL 004): - !------TOSCA-Metadata - !----- TOSCA.meta (metadata for navigating the ZIP file) - !------Definitions - !----- MRF.yaml (main VNFD file) - !----- OtherTemplates (e.g. type definitions, referenced by the main VNFD file) - !------Files - !----- ChangeLog.txt - !----- image(s) - !----- other artifacts - !------Tests - !----- file(s) - !------Licenses - !----- file(s) - !------Scripts - !----- install.sh - !----- MRF.mf - - The NFVO will return a ZIP file of the following format: - !------TOSCA-Metadata - !----- TOSCA.meta - !------Definitions - !----- MRF.yaml - !----- OtherTemplates - - EXAMPLE 2: Assuming a request is sent for the following VNF package - (a VNF package without a TOSCA-Metadata directory, as - described in clause A.2 in ETSI GS NFV-SOL 004): - !------MRF.yaml (main VNFD file) - !------MRF.mf - !------ChangeLog.txt - !------Tests - !----- file(s) - !------Licenses - !----- file(s) - !------Artifacts - !----- install.sh - !----- start.yang - - The NFVO will return a ZIP file of the following format: - !------MRF.yaml - - EXAMPLE 3: Assuming a request is sent for the following VNF package - (a VNF package with the YANG VNFD without a TOSCA-Metadata directory, - as described in clause A.3 in ETSI GS NFV SOL 004): - !----CompanyVNFD.yaml - !----CompanyVNFD.xml - !----CompanyVNFD.mf - !----ChangeLog.txt - !-----Files - !-----Instance Data Files - !---- start.xml - !-----Licenses - !-----Scripts - !----- install.sh - - The NFVO will return a ZIP file of the following format: - !----CompanyVNFD.yaml - !----CompanyVNFD.xml (indicated in the yang_definitions metadata in CompanyVNFD.yaml) - - This method shall follow the provisions specified in the tables 10.4.4.3.2-1 - and 10.4.4.3.2-2 for URI query parameters, request and response data structures, - nd response codes. + The GET method reads the content of the VNFD within a VNF package. See clause 10.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -424,12 +242,7 @@ paths: - $ref: '#/components/parameters/VnfPkgId' get: description: | - Query VNF Package Manifest - - The GET method reads the content of the manifest within a VNF package. - This method shall follow the provisions specified in the tables 10.4.4a.3.2-1 - and 10.4.4a.3.2-2 for URI query parameters, request and response data structures, - and response codes. + The GET method reads the content of the manifest within a VNF package. See clause 10.4.4a.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -466,12 +279,7 @@ paths: - $ref: '#/components/parameters/VnfdId' get: description: | - Query VNF Package Manifest - - The GET method reads the content of the manifest within a VNF package. - This method shall follow the provisions specified in the tables 10.4.4a.3.2-1 - and 10.4.4a.3.2-2 for URI query parameters, request and response data structures, - and response codes. + The GET method reads the content of the manifest within a VNF package. See clause 10.4.4a.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -511,21 +319,8 @@ paths: - $ref: '#/components/parameters/VnfPkgId' get: description: | - Fetch VNF Package. - The GET method fetches the content of a VNF package identified by the - VNF package identifier allocated by the NFVO. - The content of the package is provided as onboarded, i.e. depending on - the security option used, the CSAR or the CSAR wrapped in a ZIP archive - together with an external signature is returned, as defined in clause - 5.1 of ETSI GS NFV-SOL 004. - - NOTE: Information about the applicable security option can be obtained - by evaluating the "packageSecurityOption" attribute in the "VnfPkgInfo" - structure. - - This method shall follow the provisions specified in the tables - 10.4.5.3.2-1 and 10.4.5.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO. + See clause 10.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -576,21 +371,8 @@ paths: - $ref: '#/components/parameters/VnfdId' get: description: | - Fetch VNF Package. - The GET method fetches the content of a VNF package identified by the - VNF package identifier allocated by the NFVO. - The content of the package is provided as onboarded, i.e. depending on - the security option used, the CSAR or the CSAR wrapped in a ZIP archive - together with an external signature is returned, as defined in clause - 5.1 of ETSI GS NFV-SOL 004. - - NOTE: Information about the applicable security option can be obtained - by evaluating the "packageSecurityOption" attribute in the "VnfPkgInfo" - structure. - - This method shall follow the provisions specified in the tables - 10.4.5.3.2-1 and 10.4.5.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO. + See clause 10.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -644,30 +426,9 @@ paths: - $ref: '#/components/parameters/VnfPkgId' get: description: | - Fetch VNF Package Artifacts. - - The GET method shall return an archive that contains a set of artifacts - according to the provisions for inclusion/exclusion defined below, - embedded in a directory structure being the same as in the VNF package. - The criteria for exclusion/inclusion of an artifact in the archive are defined as follows: - - Artifacts that are software images shall be excluded from the archive. - - Artifacts that are not software images and that are external to the VNF package shall be - excluded from the archive unless the URI query parameter "include_external_artifacts" has - been provided. External artifacts shall be included in the archive using the content of - the "artifactPath" attribute as the path. - - All additional artifacts included in the VNF package that are MANO artifacts shall - be included in the archive, unless the URI query parameter "exclude_all_mano_artifacts" - has been provided, in which case such artifacts shall be excluded. - - All additional artifacts included in the VNF package that are non-MANO artifacts - shall be included in the archive, unless: -  the URI query parameter "exclude_all_non_mano_artifacts" has been provided, - in which case such artifacts shall be excluded; -  the URI query parameter "select_non_mano_artifact_sets" has been provided and - is supported by the NFVO, in which case only those non-MANO artifacts shall be - included whose non-MANO artifact set identifier matches one of the values of the query parameter. - Package metadata such as manifest file or VNFD shall not be included in the archive. - This method shall follow the provisions specified in the tables 10.4.5a.3.2-1 and - 10.4.5a.3.2-2 for URI query parameters, request and response data structures, and response codes. + The GET method shall return an archive that contains a set of artifacts according to the provisions for + inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package. + See clause 10.4.5a.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -706,30 +467,9 @@ paths: - $ref: '#/components/parameters/VnfdId' get: description: | - Fetch VNF Package Artifacts. - - The GET method shall return an archive that contains a set of artifacts - according to the provisions for inclusion/exclusion defined below, - embedded in a directory structure being the same as in the VNF package. - The criteria for exclusion/inclusion of an artifact in the archive are defined as follows: - - Artifacts that are software images shall be excluded from the archive. - - Artifacts that are not software images and that are external to the VNF package shall be - excluded from the archive unless the URI query parameter "include_external_artifacts" has - been provided. External artifacts shall be included in the archive using the content of - the "artifactPath" attribute as the path. - - All additional artifacts included in the VNF package that are MANO artifacts shall - be included in the archive, unless the URI query parameter "exclude_all_mano_artifacts" - has been provided, in which case such artifacts shall be excluded. - - All additional artifacts included in the VNF package that are non-MANO artifacts - shall be included in the archive, unless: -  the URI query parameter "exclude_all_non_mano_artifacts" has been provided, - in which case such artifacts shall be excluded; -  the URI query parameter "select_non_mano_artifact_sets" has been provided and - is supported by the NFVO, in which case only those non-MANO artifacts shall be - included whose non-MANO artifact set identifier matches one of the values of the query parameter. - Package metadata such as manifest file or VNFD shall not be included in the archive. - This method shall follow the provisions specified in the tables 10.4.5a.3.2-1 and - 10.4.5a.3.2-2 for URI query parameters, request and response data structures, and response codes. + The GET method shall return an archive that contains a set of artifacts according to the provisions for + inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package. + See clause 10.4.5a.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -772,11 +512,7 @@ paths: - $ref: '#/components/parameters/VnfPkgId' get: description: | - Fetch VNF Package Artifacts. - The GET method fetches the content of an artifact within a VNF package. - This method shall follow the provisions specified in the tables - 10.4.6.3.2-1 and 10.4.6.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method fetches the content of an artifact within a VNF package. See clause 10.4.6.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -834,11 +570,7 @@ paths: - $ref: '#/components/parameters/VnfdId' get: description: | - Fetch VNF Package Artifacts. - The GET method fetches the content of an artifact within a VNF package. - This method shall follow the provisions specified in the tables - 10.4.6.3.2-1 and 10.4.6.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method fetches the content of an artifact within a VNF package. See clause 10.4.6.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -900,25 +632,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Subscribe. - The POST method creates a new subscription. - This method shall follow the provisions specified in the tables - 10.4.7.3.1-1 and 10.4.7.3.1-2 for URI query parameters, request - and response data structures, and response codes. - As the result of successfully executing this method, a new - "Individual subscription" resource as defined in clause 10.4.8 - shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same - callback URI and the same filter can result in performance degradation - and will provide duplicates of notifications to the VNFM, and might - make sense only in very rare use cases. Consequently, the NFVO may - either allow creating a new "Individual subscription" resource if - another "Individual subscription" resource with the same filter and - callback URI already exists (in which case it shall return the - "201 Created" response code), or may decide to not create a duplicate - "Individual subscription" resource (in which case it shall return a - "303 See Other" response code referencing the existing "Individual subscription" - resource with the same filter and callback URI). + The POST method creates a new subscription. See clause 10.4.7.3.1. requestBody: $ref: '#/components/requestBodies/PkgmSubscriptionRequest' responses: @@ -957,11 +671,8 @@ paths: get: description: | - Query Subscription Information. - 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 10.4.7.3.2-1 and 10.4.7.3.2-2 - for URI query parameters, request and response data structures, and response codes. + 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. See clause 10.4.7.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker @@ -1000,11 +711,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - Query Subscription Information. - The GET method reads an individual subscription. - This method shall follow the provisions specified in the tables - 10.4.8.3.2-1 and 10.4.8.3.2-2 for URI query parameters, - request and response data structures, and response codes. + The GET method reads an individual subscription. See clause 10.4.8.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -1033,16 +740,7 @@ paths: delete: description: | - Terminate subscription. - The DELETE method terminates an individual subscription. - This method shall follow the provisions specified in the tables 10.4.8.3.5-1 and 10.4.8.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual subscription" resource - shall not exist any longer. This means that no notifications for that subscription shall be - sent to the formerly-subscribed API consumer. - - NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed - API consumer for a certain time period after the deletion. + The DELETE method terminates an individual subscription. See clause 10.4.8.3.5. responses: 204: $ref: '#/components/responses/IndividualSubscription.Delete.204' @@ -2084,4 +1782,4 @@ components: style: simple explode: false schema: - type: string \ No newline at end of file + type: string diff --git a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index a37d18dd67d5d07c2238c12d8c4d1b72bab07f3a..d49a0e3eca8a1d1a54129ce153f9260855b4c065 100644 --- a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -18,8 +18,8 @@ info: version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/callback/v2 @@ -36,11 +36,9 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 - for URI query parameters, request and response data structures, and response codes. + See clause 10.4.9.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -65,10 +63,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by - the API consumer e.g. during subscription. - This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. See clause 10.4.9.3.2. responses: 204: $ref: '#/components/responses/VnfPackageOnboardingNotification.Get.204' @@ -97,11 +93,9 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 - for URI query parameters, request and response data structures, and response codes. + See clause 10.4.9.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -126,10 +120,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided by - the API consumer e.g. during subscription. - This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. See clause 10.4.9.3.2. responses: 204: $ref: '#/components/responses/VnfPackageChangeNotification.Get.204' diff --git a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 56594fd0face041746b6df2d835fff52724b4311..dde9c9429eb3e99d53a04e864daed8a099c00ee2 100644 --- a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -18,8 +18,8 @@ info: version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vnfpm/v2 @@ -44,12 +44,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Create PM Job. - The POST method creates a PM job. - This method shall follow the provisions specified in the tables 6.4.2.3.1-1 and 6.4.2.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual PM job" resource as defined - in clause 6.4.3 shall have been created. + The POST method creates a PM job. See clause 6.4.2.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -80,11 +75,7 @@ paths: get: description: | - Query PM Job. - The API consumer can use this method to retrieve information about PM jobs. - This method shall follow the provisions specified in the tables 6.4.2.3.2-1 and 6.4.2.3.2-2 - for URI query parameters, request and response data structures, and response codes. - The API consumer can use this method to retrieve information about PM jobs. + The API consumer can use this method to retrieve information about PM jobs. See clause 6.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields @@ -127,10 +118,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - Query PM Job. - The API consumer can use this method for reading an individual PM job. - This method shall follow the provisions specified in the tables 6.4.3.3.2-1 and 6.4.3.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method for reading an individual PM job. See clause 6.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -159,10 +147,7 @@ paths: patch: description: | - This method allows to modify an "Individual PM job" resource. - This method shall follow the provisions specified in the tables - 6.4.3.3.4-1 and 6.4.3.3.4-2 for URI query parameters, request - and response data structures, and response codes. + This method allows to modify an "Individual PM job" resource. See clause 6.4.3.3.4. responses: 200: $ref: '#/components/responses/IndividualPMJob.Patch.200' @@ -191,11 +176,7 @@ paths: delete: description: | - Delete PM Job. - This method terminates an individual PM job. - This method shall follow the provisions specified in the tables 6.4.3.3.5-1 and 6.4.3.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual PM job" resource shall not exist any longer. + This method terminates an individual PM job. See clause 6.4.3.3.5. responses: 204: $ref: '#/components/responses/IndividualPMJob.Delete.200' @@ -230,9 +211,7 @@ paths: - $ref: '#/components/parameters/ReportId' get: description: | - The API consumer can use this method for reading an individual performance report. - This method shall follow the provisions specified in the tables 6.4.4.3.2-1 and 6.4.4.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method for reading an individual performance report. See clause 6.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization @@ -272,12 +251,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Create Threshold. - The POST method can be used by the API consumer to create a threshold. - This method shall follow the provisions specified in the tables 6.4.5.3.1-1 and 6.4.5.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual threshold" resource - as defined in clause 6.4.6 shall have been created. + The POST method can be used by the API consumer to create a threshold. See clause 6.4.5.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -308,10 +282,7 @@ paths: get: description: | - Query Threshold. - The API consumer can use this method to query information about thresholds. - This method shall follow the provisions specified in the tables 6.4.5.3.2-1 and 6.4.5.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method to query information about thresholds. See clause 6.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker @@ -350,10 +321,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | - Query Threshold. - The API consumer can use this method for reading an individual threshold - This method shall follow the provisions specified in the tables 6.4.6.3.2-1 and 6.4.6.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method for reading an individual threshold. See clause 6.4.6.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: @@ -382,10 +350,7 @@ paths: patch: description: | - This method allows to modify an "Individual threshold" resource. - This method shall follow the provisions specified in the tables - 6.4.6.3.4-1 and 6.4.6.3.4-2 for URI query parameters, request - and response data structures, and response codes. + This method allows to modify an "Individual threshold" resource. See clause 6.4.6.3.4. responses: 200: $ref: '#/components/responses/IndividualThreshold.Patch.200' @@ -414,12 +379,7 @@ paths: delete: description: | - Delete Threshold. - This method allows to delete a threshold. - This method shall follow the provisions specified in the tables 6.4.6.3.5-1 and 6.4.6.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual threshold" resource - shall not exist any longer. + This method allows to delete a threshold. See clause 6.4.6.3.5. responses: 204: $ref: '#/components/responses/IndividualThreshold.Delete.200' diff --git a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index d756a944292443517471aff6f6e6f3da3ad0ac01..d379b74f98459423ee6fb8b5093e631bd0f55542 100644 --- a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -18,8 +18,8 @@ info: version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/callback/v2 @@ -36,12 +36,9 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method delivers a notification regarding a performance management - event from the API producer to an API consumer. - The API consumer shall have previously created an "Individual PM Job" or "Individual threshold" resource. - This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method delivers a notification regarding a performance management event from API producer to an + API consumer. The API consumer shall have previously created an "Individual PM job" resource + or "Individual threshold" resource. See clause 6.4.9.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -66,10 +63,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided - by the API consumer, e.g. during the creation of the PM job or threshold resource. - This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, + e.g. during creation of the PM job or threshold resource. See clause 6.4.9.3.2. responses: 204: $ref: '#/components/responses/PerformanceInformationAvailableNotification.Get.204' @@ -98,12 +93,9 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | - Notify. - The POST method delivers a notification regarding a performance management - event from the API producer to an API consumer. - The API consumer shall have previously created an "Individual subscription resource" with a matching filter. - This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 - for URI query parameters, request and response data structures, and response codes. + The POST method delivers a notification regarding a performance management event from API producer to an + API consumer. The API consumer shall have previously created an "Individual PM job" resource + or "Individual threshold" resource. See clause 6.4.9.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: @@ -128,10 +120,8 @@ paths: get: description: | - The GET method allows the API producer to test the notification endpoint that is provided - by the API consumer e.g. during subscription. - This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, + e.g. during creation of the PM job or threshold resource. See clause 6.4.9.3.2. responses: 204: $ref: '#/components/responses/ThresholdCrossedNotification.Get.204' diff --git a/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml b/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml index c6934ecd97ab54ce535ca121e7ba3debafe71c82..d613c5b9f04b0e293c7ae77581363918d0b6a5a8 100644 --- a/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml +++ b/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml @@ -18,8 +18,8 @@ info: version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://0.0.0.1/vnfsnapshotpkgm/v1 @@ -38,7 +38,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: description: | - The GET method queries the information of the VNF packages matching the filter. + The GET method queries the information of the VNF packages matching the filter. See clause 12.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -79,7 +79,7 @@ paths: - $ref: '#/components/parameters/VnfSnapshotPkgId' get: description: | - The GET method reads the information of an individual VNF snapshot package. + The GET method reads the information of an individual VNF snapshot package. See clause 12.4.3.3.2 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -120,7 +120,7 @@ paths: - $ref: '#/components/parameters/VnfSnapshotPkgId' get: description: | - The GET method fetches the content of a VNF snapshot package. + The GET method fetches the content of a VNF snapshot package. See clause 12.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -164,7 +164,7 @@ paths: - $ref: '#/components/parameters/ArtifactPath' get: description: | - The GET method fetches the content of an artifact within the VNF snapshot package. + The GET method fetches the content of an artifact within the VNF snapshot package. See clause 12.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml index ec0d3cb3b9b84f17b6919802e5d43b358e3aaa43..d16a5f09509a151739622bcdd205a62433f00ff4 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml @@ -19,8 +19,8 @@ info: version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V3.3.4 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + description: ETSI GS NFV-SOL 003 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vrqan/v1 @@ -42,22 +42,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: description: | - Subscribe. - The POST method creates a new subscription. - This method shall follow the provisions specified in the tables 11.4.2.3.1-1 and 11.4.2.3.1-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual subscription" - resource as defined in clause 11.4.3 shall have been created. This method shall not - trigger any notification. - Creation of two "Individual subscription" resources with the same callback URI and - the same filter can result in performance degradation and will provide duplicates - of notifications to the VNFM, and might make sense only in very rare use cases. - Consequently, the NFVO may either allow creating a new "Individual subscription" - resource if another "Individual subscription" resource with the same filter and - callback URI already exists (in which case it shall return the "201 Created" response code), - or may decide to not create a duplicate "Individual subscription" resource (in which case - it shall return a "303 See Other" response code referencing the existing "Individual subscription" - resource with the same filter and callback URI). + The POST method creates a new subscription. See clause 11.4.2.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType @@ -99,11 +84,8 @@ paths: get: description: | - Query Subscription Information. 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 11.4.2.3.2-1 and 11.4.2.3.2-2 - for URI query parameters, request and response data structures, and response codes. + It can be used e.g. for resynchronization after error situations. See clause 11.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker @@ -143,10 +125,7 @@ paths: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: description: | - Query Subscription Information. - The GET method reads an individual subscription. - This method shall follow the provisions specified in the tables 11.4.3.3.2-1 and 11.4.3.3.2-2 - for URI query parameters, request and response data structures, and response codes. + The GET method reads an individual subscription. See clause 11.4.3.3.2. responses: 200: $ref: '#/components/responses/IndividualSubscription.Get.200' @@ -173,15 +152,7 @@ paths: delete: description: | - Terminate subscription. - The DELETE method terminates an individual subscription. - This method shall follow the provisions specified in the tables 11.4.3.3.5-1 and 11.4.3.3.5-2 - for URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual subscription" resource - shall not exist any longer. This means that no notifications for that subscription shall be - sent to the formerly-subscribed API consumer. - NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed - API consumer for a certain time period after the deletion. + The DELETE method terminates an individual subscription. See clause 11.4.3.3.5. responses: 204: $ref: '#/components/responses/IndividualSubscription.Delete.204'