Merge branch '2.8.1-dev' into '2.8.1'

SOL002 and SOL003 OpenAPI representations for v2.8.1

See merge request !16

Readme.md

 # NFV SOL002 and SOL003 APIs
 
 This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
-for the APIs defined in ETSI NFV GSs [SOL002](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_NFV-SOL002v020701p.pdf) and [SOL003](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_nfv-sol003v020701p.pdf).
+for the APIs defined in ETSI NFV GSs [SOL002](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf) and 
+[SOL003](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_nfv-sol003v020801p.pdf).
 
 The APIs described in this repository are defined for the following reference points:
 

src/SOL002/APIVersion/APIVersion.yaml

@@ -9,7 +9,7 @@ info:
     version of the ETSI Group Specification it refers to and has not been
     approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
     Group Specification takes precedence.
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
+    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
   license:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.7.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
+  description: ETSI GS NFV-SOL 002 V2.8.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
 
 schemes:
   - http

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

@@ -9,7 +9,7 @@ info:
     version of the ETSI Group Specification it refers to and has not been
     approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
     Group Specification takes precedence.
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
+    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
   license:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.7.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
+  description: ETSI GS NFV-SOL 002 V2.8.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
 
 basePath: /vnfconfig/v1
 
@@ -58,9 +58,8 @@ paths:
         required: false
         type: string
     get:
-      summary: Read VNF/VNFC configuration from VNF
       description: >
-        The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
+        The API consumer can use this method to read configuration information about a VNF instance and/or its VNFC instances.
       responses:
         200:
           description: >
@@ -113,7 +112,6 @@ paths:
         504:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
     patch:
-      summary: Modify VNF/VNFC configuration.
       description: This method sets or modifies a configuration resource.
       parameters:
         - name: configModifications

src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml

@@ -100,6 +100,7 @@ definitions:
       vnfcInstanceId:
         description: >
           Identifier of a VNFC instance to which this set of configuration data applies.
+          The identifier references the "id" attribute in a "VnfcInfo" structure.
         $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
       intCpConfig:
         description: >

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

@@ -9,7 +9,7 @@ info:
     version of the ETSI Group Specification it refers to and has not been
     approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
     Group Specification takes precedence.
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
+    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
   license:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.7.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
+  description: ETSI GS NFV-SOL 002 V2.8.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
 
 basePath: /vnffm/v1
 
@@ -43,7 +43,7 @@ paths:
   # Alarms                                                                      #
   ###############################################################################
   '/alarms':
-    #SOL003 location: 7.4.2
+    #SOL002 location: 7.4.2
     parameters:
       - name: Version
         description: >
@@ -60,7 +60,7 @@ paths:
         type: string
     get:
       description: >
-        The client can use this method to retrieve information about the alarm
+        The API consumer can use this method to retrieve information about the alarm
         list.
       parameters:
         - name: Accept
@@ -190,7 +190,7 @@ paths:
   # Individual alarm                                                            #
   ###############################################################################
   '/alarms/{alarmId}':
-    #SOL003 location: 7.4.3
+    #SOL002 location: 7.4.3
     parameters:
       - name: alarmId
         description: >
@@ -218,7 +218,7 @@ paths:
         type: string
     get:
       description: >
-        The client can use this method to read an individual alarm.
+        The API consumer can use this method to read an individual alarm.
       parameters:
         - name: Accept
           description: >
@@ -474,7 +474,7 @@ paths:
   # Subscriptions                                                               #
   ###############################################################################
   '/subscriptions':
-    #SOL003 location: 7.4.4
+    #SOL002 location: 7.4.5
     parameters:
       - name: Version
         description: >
@@ -602,8 +602,8 @@ paths:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
     get:
       description: >
-        The client can use this method to retrieve the list of active
-        subscriptions for VNF alarms subscribed by the client. It can be used
+        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.
       parameters:
         - name: Accept
@@ -667,7 +667,7 @@ paths:
           description: >
             200 OK
 
-            The list of subscriptions has been queried successfully. The response
+            Shall be returned when the list of subscriptions has been queried successfully. The response
             body shall contain the representations of all active
             subscriptions of the functional block that invokes the method.
             If the "filter" URI parameter was supplied in the request, the data 
@@ -759,8 +759,8 @@ paths:
         type: string
     get:
       description: >
-        The client can use this method for reading an individual subscription
-        for VNF alarms subscribed by the client.
+        The API consumer can use this method for reading an individual subscription
+        for VNF alarms subscribed by the API consumer.
       parameters:
         - name: Accept
           description: >

src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml

@@ -28,7 +28,9 @@ definitions:
         $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
       vnfcInstanceIds:
         description: >
-          Identifiers of the affected VNFC instances.
+          Identifiers of the affected VNFC instances. Each identifier references the "id" 
+          attribute in a "VnfcInfo" structure. Shall be present if the alarm affects at 
+          least one VNFC instance.
         type: array
         items:
           $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

@@ -9,7 +9,7 @@ info:
     version of the ETSI Group Specification it refers to and has not been
     approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
     Group Specification takes precedence.
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
+    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
   license:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.7.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
+  description: ETSI GS NFV-SOL 002 V2.8.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
 
 basePath: /callback/v1
 
@@ -36,7 +36,7 @@ paths:
   ###############################################################################
   # Notification endpoint AlarmNotification                                     #
   ###############################################################################
-  '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmNotification':
+  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
     parameters:
       - name: Version
         description: >
@@ -112,8 +112,8 @@ paths:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
     get:
       description: >
-        The GET method allows the server to test the notification endpoint
-        that is provided by the client, e.g. during subscription.
+        The GET method allows the API producer to test the notification endpoint
+        that is provided by the API consumer, e.g. during subscription.
       responses:
         204:
           description: >
@@ -154,7 +154,7 @@ paths:
   ###############################################################################
   # Notification endpoint AlarmClearedNotification                              #
   ###############################################################################
-  '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmClearedNotification':
+  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
     parameters:
       - name: Version
         description: >
@@ -230,8 +230,8 @@ paths:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
     get:
       description: >
-        The GET method allows the server to test the notification endpoint
-        that is provided by the client, e.g. during subscription.
+        The GET method allows the API producer to test the notification endpoint
+        that is provided by the API consumer, e.g. during subscription.
       responses:
         204:
           description: >
@@ -272,7 +272,7 @@ paths:
   ###############################################################################
   # Notification endpoint AlarmListRebuiltNotification                          #
   ###############################################################################
-  '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmListRebuiltNotification':
+  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
     parameters:
       - name: Version
         description: >
@@ -348,8 +348,8 @@ paths:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
     get:
       description: >
-        The GET method allows the server to test the notification endpoint
-        that is provided by the client, e.g. during subscription.
+        The GET method allows the API producer to test the notification endpoint
+        that is provided by the API consumer, e.g. during subscription.
       responses:
         204:
           description: >

src/SOL002/VNFIndicator/VNFIndicator.yaml

@@ -9,7 +9,7 @@ info:
     version of the ETSI Group Specification it refers to and has not been
     approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
     Group Specification takes precedence.
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
+    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
   license:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.7.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
+  description: ETSI GS NFV-SOL 002 V2.8.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
 
 basePath: /vnfind/v1
 
@@ -58,7 +58,6 @@ paths:
         required: false
         type: string
     get:
-      summary: Query multiple indicators
       description: Get a list of indicators. Support of attribute based filtering via query parameters.
       parameters:
         - name: filter
@@ -110,8 +109,8 @@ paths:
 
             Shall be returned when information about zero or more VNF indicators was 
             queried successfully. The response body shall contain in an array the 
-            representations of all VNF indicators that match the attribute-based 
-            filtering parameters, i.e. zero or more representations of VNF indicators 
+            representations of all VNF indicators that match the attribute
+            filter, i.e. zero or more representations of VNF indicators
             as defined in clause 8.5.2.2.
             If the "filter" URI parameter was supplied in the request, the data in 
             the response body shall have been transformed according to the rules 
@@ -195,7 +194,6 @@ paths:
         required: false
         type: string
     get:
-      summary: Query multiple indicators related to a VNF instance.
       description: >
         Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.
       parameters:
@@ -341,7 +339,6 @@ paths:
         required: false
         type: string
     get:
-      summary: Read an inidividual VNF indicator related to a VNF instance.
       description: >
         Read an individual VNF indicator related to a specific VNF instance.
         NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a
@@ -396,7 +393,6 @@ paths:
   ###############################################################################
   /subscriptions:
     post:
-      summary: Create a new subscription to VNF indicator change notifications
       description: >
         This method creates a new subscription.
         As the result of successfully executing this method, a new "Individual 
@@ -518,7 +514,6 @@ paths:
         504:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
     get:
-      summary: Query multiple subscriptions.
       description: >
         Service Unavailable
 
@@ -649,11 +644,10 @@ paths:
         required: false
         type: string
     get:
-      summary: Read an individual subscription.
       description: >
         Service Unavailable
 
-        This resource represents an individual subscription. The client can use this resource to
+        This resource represents an individual subscription. The API consumer can use this resource to
         read and to terminate a subscription to notifications related to VNF indicator value changes.
       parameters:
         - name: subscriptionId
@@ -713,7 +707,6 @@ paths:
         504:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
     delete:
-      summary: Delete a subscription
       description: >
         This method terminates an individual subscription.
         As the result of successfully executing this method, the "Individual 
@@ -741,7 +734,7 @@ paths:
           description: >
             204 NO CONTENT
 
-            Shall be returned when the subscription has been deleted successfully.
+            Shall be returned when the "Individual subscription" has been deleted successfully.
             The response body shall be empty.
           headers:
             Version:

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

@@ -2,14 +2,14 @@ swagger: "2.0"
 
 info:
   version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
-  title: SOL002 - VNF Indicator Notification Endpoint interface
+  title: SOL002 - VNF Indicator Notification interface
   description: >
-    SOL002 - VNF Indicator Notification Endpoint interface
+    SOL002 - VNF Indicator Notification interface
     IMPORTANT: Please note that this file might be not aligned to the current
     version of the ETSI Group Specification it refers to and has not been
     approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
     Group Specification takes precedence.
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
+    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
   license:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.7.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
+  description: ETSI GS NFV-SOL 002 V2.8.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
 
 schemes:
   - http
@@ -34,7 +34,7 @@ paths:
   ###############################################################################
   # Notification endpoint VnfIndicatorValueChangeNotification                   #
   ###############################################################################
-  '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':
+  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIndicatorValueChangeNotification':
     parameters:
       - name: Version
         description: >
@@ -50,7 +50,6 @@ paths:
         required: false
         type: string
     post:
-      summary: Notification endpoint
       description: >
         The API producer can use this resource to send notifications related to VNF indicator