Merge branch '2.5.1-dev'

.gitignore

 build/
 *.pyc
+ 

src/SOL002/APIVersion/APIVersion.yaml

+swagger: "2.0"
+
+info:
+  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
+  title: SOL002 - API version interface
+  description: >
+    SOL002 - API version 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
+  license:
+    name: ETSI Forge copyright notice
+    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
+  contact:
+    name: NFV-SOL WG
+
+externalDocs:
+  description: ETSI GS NFV-SOL 002 V2.5.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
+
+schemes:
+  - http
+  - https
+
+consumes:
+  - application/json
+
+produces:
+  - application/json
+
+paths:
+  ###############################################################################
+  # API Versions                                                                #
+  ###############################################################################
+  '/vnfconfig/api-versions':
+    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
+
+  '/vnffm/api-versions':
+    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
+
+  '/vnfind/api-versions':
+    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
+
+  '/vnflcm/api-versions':
+    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
+
+  '/vnfpm/api-versions':
+    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
\ No newline at end of file

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

 swagger: "2.0"
 
 info:
-  version: "1.1.0"
+  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
   title: SOL002 - VNF Configuration interface
   description: >
-    VNF Configuration interface of ETSI NFV SOL002
-
-
+    SOL002 - VNF Configuration Interface
     IMPORTANT: Please note that this file might be not aligned to the current
-    version of the ETSI Group Specification it refers to. 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&list_id=61&product=NFV&resolution=---
+    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
   license:
-    name: "ETSI Forge copyright notice"
+    name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
+  contact:
+    name: NFV-SOL WG
+
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.4.1
-  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
+  description: ETSI GS NFV-SOL 002 V2.5.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
 
 basePath: /vnfconfig/v1
 
@@ -32,70 +32,141 @@ consumes:
 produces:
   - application/json
 
-
 paths:
-###############################################################################
-# Configuration                                                               #
-###############################################################################
-    /configuration:
-      #SOL002 location: 9.4.2
+  ###############################################################################
+  # API Versions                                                                #
+  ###############################################################################
+  '/api-versions':
+    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
+
+  ###############################################################################
+  # VNF Configuration                                                           #
+  ###############################################################################
+  '/configuration':
+    parameters:
+      - name: Version
+        description: >
+          Version of the API requested to use when responding to this request.
+        in: header
+        required: true
+        type: string
+      - name: Authorization
+        description: >
+          The authorization token for the request.
+          Reference: IETF RFC 7235
+        in: header
+        required: false
+        type: string
     get:
-        summary: Read VNF/VNFC configuration from VNF.
+      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.
       responses:
         200:
           description: >
-              OK
-              
+            200 OK
             Configuration information about a VNF instance was read successfully.
             The response body shall contain a representation of the configuration resource.
           schema:
-              $ref: '#/definitions/VnfConfiguration'                  
-          400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
-          401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
-          403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
-          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
-          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
-          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
-          409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' }
-          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
-          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
-          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
-          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
+            $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration'
+          headers:
+            Content-Type:
+              description: The MIME type of the body of the response.
+              type: string
+              maximum: 1
+              minimum: 1
+            Version:
+              description: The used API version.
+              type: string
+              maximum: 1
+              minimum: 1
+            WWW-Authenticate:
+              description: >
+                Challenge if the corresponding HTTP request has not provided
+                authorization, or error details if the corresponding HTTP
+                request has provided an invalid authorization token.
+              type: string
+              maximum: 1
+              minimum: 0
+        400:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
+        401:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
+        403:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
+        404:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
+        405:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
+        406:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
+        416:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
+        422:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
+        429:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
+        500:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
+        503:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
+        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
-           description: The parameter for the configuration modification.
+          description: >
+            The parameter for the configuration modification, as defined in
+            clause 9.5.2.2.
           required: true
           in: body
           schema:
-             $ref: '#/definitions/VnfConfigModifications'            
+            $ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
       responses:
         200:
           description: >
-              OK
+            200 OK
 
             The request was accepted and completed. The response body shall contain the parameters
             of the configuration modification that was applied to the configuration resource.
           schema:
-              $ref: '#/definitions/VnfConfigModifications'                  
-          412: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/412' }
-          400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
-          401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
-          403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
-          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
-          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
-          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
-          409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' }
-          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
-          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
-          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
-          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
-definitions:
-  VnfConfiguration:
-    $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfiguration'
-  VnfConfigModifications: 
-    $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
+            $ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
+          headers:
+            Content-Type:
+              description: The MIME type of the body of the response.
+              type: string
+              maximum: 1
+              minimum: 1
+            Version:
+              description: The used API version.
+              type: string
+              maximum: 1
+              minimum: 1
+        400:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
+        401:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
+        403:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
+        404:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
+        405:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
+        406:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
+        412:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
+        416:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
+        422:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
+        429:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
+        500:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
+        503:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
+        504:
+          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
\ No newline at end of file

src/SOL002/VNFConfiguration/definitions/VnfConfiguration_def.yaml → src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml

-definitions:
-
-  VnfConfiguration:
-    description: >
-      This type represents configuration parameters of a VNF instance and its VNFC instances.
-    type: object
-    required:
-      - vnfConfigurationData
-    properties:
-      vnfConfigurationData:
-        description: >
-          Configuration parameters of the VNF instance.
-        $ref: '#/definitions/VnfConfigurationData'                  
-      vnfcConfigurationData:
-        description: >
-          Configuration parameters of the VNFC instances.
-        type: array
-        items:
-          $ref: '#/definitions/VnfcConfigurationData'                  
-
+# Copyright (c) ETSI 2017.
+# https://forge.etsi.org/etsi-forge-copyright-notice.txt
 
+definitions:
   VnfConfigModifications:
     description: >
       This type represents request parameters for the "Set Configuration" operation.
@@ -59,7 +42,31 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/VnfcConfigurationData'
+      vnfcConfigurationDataDeleteIds:
+        description: >
+          List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used
+          as "deleteIdList" as defined below this table.
+        type: array
+        items:
+          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
 
+  VnfConfiguration:
+    description: >
+      This type represents configuration parameters of a VNF instance and its VNFC instances.
+    type: object
+    required:
+      - vnfConfigurationData
+    properties:
+      vnfConfigurationData:
+        description: >
+          Configuration parameters of the VNF instance.
+        $ref: '#/definitions/VnfConfigurationData'
+      vnfcConfigurationData:
+        description: >
+          Configuration parameters of the VNFC instances.
+        type: array
+        items:
+          $ref: '#/definitions/VnfcConfigurationData'
 
   VnfConfigurationData:
     description: >
@@ -81,7 +88,6 @@ definitions:
           VNFD as "VnfConfigurableProperties".
         $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs'
 
-
   VnfcConfigurationData:
     description: >
       This type represents configuration parameters of a VNFC instance.
@@ -93,11 +99,9 @@ definitions:
         description: >
           Identifier of a VNFC instance to which this set of configuration data applies.
         $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
-      intCpConfig:
+      extCpConfig:
         description: >
-          Configuration parameters for the internal CPs of the VNFC instance.
-        type: array
-        items:
+          Configuration parameters for the external CPs of the VNFC instance.
         $ref: '#/definitions/CpConfiguration'
       dhcpServer:
         description: >
@@ -110,7 +114,6 @@ definitions:
           VNFD as "VnfcConfigurableProperties".
         $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs'
 
-
   CpConfiguration:
     description: >
       This type represents configuration parameters of a CP instance.
@@ -164,7 +167,3 @@ definitions:
         description: >
           The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).
         type: integer
\ No newline at end of file
-
-
-
-

src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml

-responses:
-  409:
-    description: >
-      Conflict
-
-      Another request is in progress that prohibits the fulfilment of
-      the current request, or the current resource state is inconsistent
-      with the request.
-    headers:
-      Content-Type:
-        description: The MIME type of the body of the response.
-        type: string
-        maximum: 1
-        minimum: 1
-    schema:
-      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

src/SOL002/VNFFaultManagement/definitions/VNFFaultManagement_def.yaml → src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml

@@ -9,6 +9,7 @@ definitions:
     required:
       - id
       - managedObjectId
+      - vnfcInstanceIds
       - rootCauseFaultyResource
       - alarmRaisedTime
       - ackState
@@ -27,6 +28,12 @@ definitions:
         description: >
           Identifier of the affected VNF instance.
         $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
+      vnfcInstanceIds:
+        description: >
+          Identifiers of the affected VNFC instances.
+        type: array
+        items:
+          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
       rootCauseFaultyResource:
         description: >
           The virtualised resources that are causing the VNF fault.
@@ -57,19 +64,17 @@ definitions:
           - UNACKNOWLEDGED
           - ACKNOWLEDGED
       perceivedSeverity:
-        #description: >
-        #  Perceived severity of the managed object failure.
-        # $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
-        type: string
+        description: >
+          Perceived severity of the managed object failure.
+        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
       eventTime:
         description: >
           Time stamp indicating when the fault was observed.
         $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
       eventType:
-        #description: >
-        #  Type of event.
-        # todo: Fix
-        #$ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType"
+        description: >
+          Type of event.
+        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType"
         type: string
       faultType:
         description: >
@@ -84,7 +89,7 @@ definitions:
           Attribute indicating if this fault is the root for other correlated
           alarms. If TRUE, then the alarms listed in the attribute
           CorrelatedAlarmId are caused by this fault.
-        type: boolean
+        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
       correlatedAlarmIds:
         description: >
           List of identifiers of other alarms correlated to this fault.
@@ -105,14 +110,23 @@ definitions:
           - self
         properties:
           self:
-            #description: >
-            #  URI of this resource.
+            description: >
+              URI of this resource.
             $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
           objectInstance:
-            #description: >
-            #  Link to the resource representing the VNF instance to which the
-            #  notified alarm is correlated. Shall be present if the VNF
-            #  instance information is accessible as a resource.
+            description: >
+              Link to the resource representing the VNF instance to which the
+              notified alarm is correlated. Shall be present if the VNF
+              instance information is accessible as a resource.
             $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
+
   PerceivedSeverityRequest:
-    type: string
\ No newline at end of file
+    description: >
+      This type represents the escalated value of the perceived severity for an alarm.
+    required:
+      - proposedPerceivedSeverity
+    properties:
+      proposedPerceivedSeverity:
+        description: >
+          Indicates the proposed escalated perceived severity for an alarm.
+        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
\ No newline at end of file

src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml

-# Copyright (c) ETSI 2017.
-# https://forge.etsi.org/etsi-forge-copyright-notice.txt
-
-responses:
-  409-alarm-state-conflict:
-    description: >
-      Conflict
-
-      The operation cannot be executed currently, due to a conflict with the
-      state of the "Individual alarm" resource.
-      Typically, this is due to the fact that the alarm is already in the
-      state that is requested to be set (such as trying to acknowledge an
-      already-acknowledged alarm).
-      The response body shall contain a ProblemDetails structure, in which the
-      "detail" attribute should convey more information about the error.
-    headers:
-      Content-Type:
-        description: The MIME type of the body of the response.
-        type: string
-        maximum: 1
-        minimum: 1
-      WWW-Authenticate:
-        description: >
-          Challenge if the corresponding HTTP request has not provided
-          authorization, or error details if the corresponding HTTP
-          request has provided an invalid authorization token.
-        type: string
-        maximum: 1
-        minimum: 0
-    schema:
-      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

 swagger: "2.0"
 
 info:
-  version: "1.1.0"
+  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
   title: SOL002 - VNF Fault Management Notification interface
   description: >
     SOL002 - VNF Fault Management Notification interface
-
-
     IMPORTANT: Please note that this file might be not aligned to the current
-    version of the ETSI Group Specification it refers to. In case of
-    discrepancies the published ETSI Group Specification takes precedence.
-
-
-    In clause 4.3.2 of ETSI GS NFV-SOL 002 v2.4.1, an attribute-based
-    filtering mechanism is defined. This mechanism is currently not
-    included in the corresponding OpenAPI design for this GS version. Changes
-    to the attribute-based filtering mechanism are being considered in v2.5.1
-    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
-    design.
-
-    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
+    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
   license:
-    name: "ETSI Forge copyright notice"
+    name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
+  contact:
+    name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 002 V2.4.1
-  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
+  description: ETSI GS NFV-SOL 002 V2.5.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
 
-basePath: "/callback/v1"
+basePath: /callback/v1
 
 schemes:
+  - http
   - https
 
 consumes:
-  - "application/json"
+  - application/json
+
 produces:
-  - "application/json"
+  - application/json
 
 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: >
+          Version of the API requested to use when responding to this request.
+        in: header
+        required: true
+        type: string
+      - name: Authorization
+        description: >
+          The authorization token for the request.
+          Reference: IETF RFC 7235
+        in: header
+        required: false
+        type: string
     post:
       description: >
         Notify
 
-
         The POST method notifies a VNF alarm or that the alarm list has been
         rebuilt.
       parameters:
@@ -57,14 +64,7 @@ paths:
           in: body
           required: true
           schema:
-            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/AlarmNotification"