Added Notes in descriptions & data type references

src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml

@@ -12,8 +12,8 @@ info:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
 externalDocs:
-  description: ETSI GS NFV-SOL 009 V3.3.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
+  description: ETSI GS NFV-SOL 009 V3.5.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
 
 servers:
   - url: http://127.0.0.1/nfvmanofm/v1
@@ -26,10 +26,7 @@ paths:
   /alarms:
     get:
       description: >
-        Get Alarm List. The client can use this method to retrieve information
-        about the alarm list. This method shall follow the provisions specified
-        in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters,
-        request and response data structures, and response codes.
+        The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -64,10 +61,7 @@ paths:
       - $ref: "#/components/parameters/alarmId"
     get:
       description: >
-        The client can use this method to read an individual alarm. This method
-        shall follow the provisions specified in the tables 7.5.4.3.2-1 and
-        7.5.4.3.2-2 for URI query parameters, request and response data
-        structures, and response codes.
+        The client can use this method to read an individual alarm. See clause 7.5.4.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -97,10 +91,7 @@ paths:
           $ref: ../components/SOL009_resp.yaml#/components/responses/504
     patch:
       description: >
-        This method modifies an "Individual alarm" resource. This method shall
-        follow the provisions specified in the tables 7.5.4.3.4-1 and
-        7.5.4.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.5.4.3.4.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -138,24 +129,7 @@ paths:
   /subscriptions:
     post:
       description: >
-        Subscribe. The POST method creates a new subscription. This method shall
-        follow the provisions specified in the tables 7.5.5.3.1-1 and
-        7.5.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 subscription" resource as defined in
-        clause 7.5.6 shall have been created. This method shall not trigger any
-        notification. Creation of two "Individual subscription" resources with
-        the same callbackURI and the same filter can result in performance
-        degradation and will provide duplicates of notifications to the API
-        consumer, and might make sense only in very rare use cases.
-        Consequently, the NFV-MANO functional entity may either allow creating a
-        new "Individual subscription" resource if another "Individual
-        subscription" resource with the same filter and callbackUri 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 callbackUri).
+        The POST method creates a new subscription. See clause 7.5.5.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -190,12 +164,9 @@ paths:
           $ref: ../components/SOL009_resp.yaml#/components/responses/504
     get:
       description: >
-        Query Subscription Information
-
         The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
-        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. This method
-        shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters,
-        request and response data structures, and response codes.
+        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.
+        See clause 7.5.5.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -230,11 +201,8 @@ paths:
       - $ref: "#/components/parameters/subscriptionId"
     get:
       description: >
-        Query Subscription Information. The client can use this method for
-        reading an individual subscription for NFV-MANO functional entity alarms
-        subscribed by the client. This method shall follow the provisions
-        specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query
-        parameters, request and response data structures, and response codes.
+        The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms
+        subscribed by the client. See clause 7.5.6.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -264,16 +232,7 @@ paths:
           $ref: ../components/SOL009_resp.yaml#/components/responses/504
     delete:
       description: >
-        Terminate Subscription. This method terminates an individual
-        subscription. This method shall follow the provisions specified in the
-        tables 7.5.6.3.5-1 and 7.5.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.
+        This method terminates an individual subscription. See clause 7.5.6.3.5.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -417,7 +376,8 @@ components:
         structure, the following applies: All attributes shall match in order for the filter to match (logical "and"
         between different filter attributes). If an attribute is an array, the attribute shall match if at least one
         of the values in the array matches (logical "or" between the values of one filter attribute).
-
+        * NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
+                of the notification types to facilitate automated code generation systems.
       type: object
       properties:
         notificationTypes:
@@ -427,9 +387,8 @@ components:
             * AlarmNotification
             * AlarmClearedNotification
             * AlarmListRebuiltNotification
-            The permitted values of the "notificationTypes" attribute are
-            spelled exactly as the names of the notification types to
-            facilitate automated code generation systems.
+
+            See note.
           type: array
           items:
             type: string

src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml

 openapi: 3.0.2
 info:
-  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
+  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
   title: SOL009 - NFV-MANO Fault Management Notification Operation
   description: >
     SOL009 - NFV-MANO Fault Management Notification Operation
@@ -12,8 +12,8 @@ info:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
 externalDocs:
-  description: ETSI GS NFV-SOL 009 V3.3.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
+  description: ETSI GS NFV-SOL 009 V3.5.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
 
 security:
   - OauthSecurity:
@@ -29,10 +29,7 @@ paths:
       description: >
         The POST method notifies an NFV-MANO functional entity 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.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
-        response data structures, and response codes.
+        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
@@ -59,10 +56,7 @@ paths:
     get:
       description: >
         The GET method allows the server to test the notification endpoint that
-        is provided by the client, e.g. during subscription. This method shall
-        follow the provisions specified in the tables 7.5.7.3.2-1 and
-        7.5.7.3.2-2 for URI query parameters, request and response data
-        structures, and response codes.
+        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -88,10 +82,7 @@ paths:
       description: >
         The POST method notifies an NFV-MANO functional entity 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.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
-        response data structures, and response codes.
+        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
@@ -118,10 +109,7 @@ paths:
     get:
       description: >
         The GET method allows the server to test the notification endpoint that
-        is provided by the client, e.g. during subscription. This method shall
-        follow the provisions specified in the tables 7.5.7.3.2-1 and
-        7.5.7.3.2-2 for URI query parameters, request and response data
-        structures, and response codes.
+        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -147,10 +135,7 @@ paths:
       description: >
         The POST method notifies an NFV-MANO functional entity 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.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
-        response data structures, and response codes.
+        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
@@ -177,10 +162,7 @@ paths:
     get:
       description: >
         The GET method allows the server to test the notification endpoint that
-        is provided by the client, e.g. during subscription. This method shall
-        follow the provisions specified in the tables 7.5.7.3.2-1 and
-        7.5.7.3.2-2 for URI query parameters, request and response data
-        structures, and response codes.
+        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"

src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml

 openapi: 3.0.2
 info:
-  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
+  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
   title: SOL009 - NFV-MANO Log Management interface
   description: >
     SOL009 - NFV-MANO Log Management interface
@@ -13,8 +13,8 @@ info:
     name: ETSI Forge copyright notice
     url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
 externalDocs:
-  description: ETSI GS NFV-SOL 009 V3.3.1
-  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
+  description: ETSI GS NFV-SOL 009 V3.5.1
+  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
 
 security:
   - OauthSecurity:
@@ -32,11 +32,7 @@ paths:
       This resource represents logging jobs. The API consumer can use this resource to create and query logging jobs.
     post:
       description: >-
-        The POST method creates a logging job.
-        This method shall follow the provisions specified in the tables 8.5.3.3.1-1 and 8.5.3.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 logging job" resource as defined in
-        clause 9.5.4 shall have been created.
+        The POST method creates a logging job. See clause 8.5.3.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -69,9 +65,7 @@ paths:
           $ref: ../components/SOL009_resp.yaml#/components/responses/504
     get:
       description: >-
-        The API consumer can use this method to retrieve information about logging jobs.
-        This method shall follow the provisions specified in the tables 8.5.3.3.2-1 and 8.5.3.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 logging jobs. See clause 8.5.3.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/filter"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
@@ -114,9 +108,7 @@ paths:
       - $ref: "#/components/parameters/logJobId"
     get:
       description: >-
-        The API consumer can use this method for reading an individual logging job.
-        This method shall follow the provisions specified in the tables 8.5.4.3.2-1 and 8.5.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 logging job. See clause 8.5.4.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -148,11 +140,7 @@ paths:
 
     delete:
       description: >-
-        This method terminates an individual logging job.
-        This method shall follow the provisions specified in the tables 8.5.4.3.5-1 and 8.5.4.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 logging job" resource shall not
-        exist any longer
+        This method terminates an individual logging job. See clause 8.5.4.3.5.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -192,9 +180,7 @@ paths:
       - $ref: "#/components/parameters/logReportId"
     get:
       description: >-
-        The API consumer can use this method for reading an individual log report.
-        This method shall follow the provisions specified in the tables 8.5.5.3.2-1 and
-        8.5.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 log report. See clause 8.5.5.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -240,8 +226,7 @@ paths:
     post:
       description: >-
         The POST method requests to compile the logged data into a file and create an associated log report.
-        This method shall follow the provisions specified in the tables 8.5.6.3.1-1 and 8.5.6.3.1-2 for URI
-        query parameters, request and response data structures, and response codes.
+        See clause 8.5.6.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -283,18 +268,7 @@ paths:
       related to NFV-MANO performance management and to query its subscriptions.
     post:
       description: >-
-        The POST method creates a new subscription.
-        This method shall follow the provisions specified in the tables 8.5.7.3.1-1 and 8.5.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 8.5.8 shall have been created. This method shall not trigger any notification.
-        Creation of two "Individual subscription" resources with the same callbackURI and the same filter can result
-        in performance degradation and will provide duplicates of notifications to the API consumer, and might make
-        sense only in very rare use cases. Consequently, the NFV-MANO functional entity may either allow creating a
-        new "Individual subscription" resource if another "Individual subscription" resource with the same filter
-        and callbackUri 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 callbackUri).
+        The POST method creates a new subscription. See clause 8.5.7.3.1.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -333,9 +307,7 @@ paths:
     get:
       description: >-
         The API consumer can use this method to query the list of active subscriptions to log management
-        notifications subscribed by the API consumer.
-        This method shall follow the provisions specified in the tables 8.5.7.3.2-1 and 8.5.7.3.2-2 for URI
-        query parameters, request and response data structures, and response codes.
+        notifications subscribed by the API consumer. See clause 8.5.7.3.2.
 
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/filter"
@@ -375,9 +347,7 @@ paths:
     get:
       description: >-
         The API consumer can use this method for reading an individual subscription about log management
-        notifications subscribed by the API consumer.
-        This method shall follow the provisions specified in the tables 8.5.8.3.2-1 and 8.5.8.3.2-2 for
-        URI query parameters, request and response data structures, and response codes.
+        notifications subscribed by the API consumer. See clause 8.5.8.3.2.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -406,14 +376,7 @@ paths:
 
     delete:
       description: >-
-        This method terminates an individual subscription.
-        This method shall follow the provisions specified in the tables 8.5.8.3.5-1 and 8.5.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.
+        This method terminates an individual subscription. See clause 8.5.8.3.5.
       parameters:
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
         - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -1054,11 +1017,9 @@ components:
     LogmNotificationsFilter:
       description: >-
         This type represents a filter that can be used to subscribe for notifications related to log
-        management events. It shall comply with the provisions defined in table 8.6.3.7-1.
-        At a particular nesting level in the filter structure, the following applies: All attributes
-        shall match in order for the filter to match (logical "and" between different filter attributes).
-        If an attribute is an array, the attribute shall match if at least one of the values in the array matches
-        (logical "or" between the values of one filter attribute).
+        management events.
+        * NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
+                of the notification types to facilitate automated code generation systems.
       type: object
       properties:
         objectInstanceFilter:
@@ -1070,6 +1031,7 @@ components:
             Match particular notification types.
             Permitted values:
             - LogReportAvailableNotification
+            See note.
           type: string
           enum: [LogReportAvailableNotification]
 
@@ -1156,7 +1118,8 @@ components:
     LogReport:
       description: >
         This type represents a log report, which provides information about a compiled log and how to obtain it.
-        It shall comply with the provisions defined in table 8.6.2.7-1.
+        * NOTE:	It is not specified in the present document how the NFV-MANO functional entity's private
+                key is provided to the NFV-MANO functional entity.
       type: object
       required:
         - id
@@ -1221,8 +1184,8 @@ components:
                 - HTTPS: transmission over HTTP Secure (HTTPS).
                 - SFTP: transmission over SSH file transfer protocol (SFTP).
                 - SCP: transmission over secure copy protocol (SCP).
-                - FTPS: transmission over file transfer protocol secure (FTPS), as specified in IETF RFC 2228 [i.11],
-                     using explicit mode as specified in IETF RFC 4217 [i.12]. If FTPS is supported, "private" protection level shall be used.
+                - FTPS: transmission over file transfer protocol secure (FTPS), as specified in IETF RFC 2228,
+                     using explicit mode as specified in IETF RFC 4217. If FTPS is supported, "private" protection level shall be used.
 
                 HTTPS shall be supported, and other protocols may be supported.
               type: string
@@ -1262,13 +1225,13 @@ components:
               description: >-
                 The cryptographic algorithm used for the encryption. Shall be present if the compiled log file is
                 encrypted. Valid values are: "AES-CBC-128", "AES-GCM-128", "AES-CBC-256", and "AES-GCM-256",
-                as specified in clause 6.5 of ETSI GS NFV-SEC 012 [14].
+                as specified in clause 6.5 of ETSI GS NFV-SEC 012.
               type: string
             logFileSignature:
               description: >-
                 Signature to the compiled log file generated with the NFV-MANO functional entity’s private key,
                 which is used to ensure the authenticity of the compiled log file. The signature shall be applied
-                according to the "encryptAndSignOrder" of the "LoggingJobConfig".
+                according to the "encryptAndSignOrder" of the "LoggingJobConfig". See note.
               type: string
             signingCertificate:
               description: >-
@@ -1416,8 +1379,10 @@ components:
 
     LoggingJobCriteria:
       description: >-
-        This type represents collection criteria for logging jobs. It shall comply with the provisions
-        defined in table 8.6.3.2-1.
+        This type represents collection criteria for logging jobs.