From a960fdf4cfa75c54d01dde46e24503c518870d37 Mon Sep 17 00:00:00 2001 From: Bertrand Souville Date: Mon, 14 Apr 2025 18:35:58 +0200 Subject: [PATCH] Address Feedback from ETSI EditHelp --- .../NFVICapacityInformation.yaml | 6 ++--- src/SOL005/NSDManagement/NSDManagement.yaml | 26 +++++++++---------- .../NSFaultManagement/NSFaultManagement.yaml | 2 +- .../NSLifecycleManagement.yaml | 12 +++------ .../SOL005NSLifecycleManagement_def.yaml | 23 ++++++++-------- .../NSLifecycleManagementNotification.yaml | 6 ++--- .../NSPerformanceManagement.yaml | 12 ++++----- .../VNFPackageManagement.yaml | 11 +++----- 8 files changed, 44 insertions(+), 54 deletions(-) diff --git a/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml b/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml index 1471ad5..e64f5e2 100644 --- a/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml +++ b/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml @@ -152,11 +152,9 @@ paths: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization get: description: | - This method shall follow the provisions specified in the tables 10.4.3a.3.2-1 and 10.4.3a.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 CCM's NFVI capacity information. + See clause 10.4.3a.3.2. - NOTE: This identifier can be retrieved from the "ccmId" attribute in the CapacityShortageNotification. - It can also be retrieved from the "ccmId" attribute in the message content of the response. parameters: - in: query name: filter diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index 6878e1b..38a3b57 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -37,7 +37,7 @@ paths: # NS Descriptors # ############################################################################### /ns_descriptors: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2 + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.2 parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization - $ref: ../components/SOL005_params.yaml#/components/parameters/Version @@ -128,7 +128,7 @@ paths: # Individual NS Descriptor # ############################################################################### /ns_descriptors/{nsdInfoId}: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3 + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.3 parameters: - $ref: '#/components/parameters/NsdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -229,7 +229,7 @@ paths: # NSD Archive Content # ############################################################################### /ns_descriptors/{nsdInfoId}/nsd_content: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4 + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.4 parameters: - $ref: '#/components/parameters/NsdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -323,7 +323,7 @@ paths: # NSD # ############################################################################### /ns_descriptors/{nsdInfoId}/nsd: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.4a parameters: - $ref: '#/components/parameters/NsdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -363,7 +363,7 @@ paths: # NSD Archive Manifest # ############################################################################### /ns_descriptors/{nsdInfoId}/manifest: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.4b parameters: - $ref: '#/components/parameters/NsdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -371,7 +371,7 @@ paths: get: description: | - The GET method reads the content of the manifest file within an NSD archive. See clasue 5.4.4b.3.2. + The GET method reads the content of the manifest file within an NSD archive. See clause 5.4.4b.3.2. parameters: - $ref: '#/components/parameters/AcceptTextOrZip' - in: query @@ -413,7 +413,7 @@ paths: # Individual NSD Archive Artifact # ############################################################################### /ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}: - #ETSI GS NFV-SOL 005 V3.5.1 location: 5.4.4c + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.4c parameters: - $ref: '#/components/parameters/NsdInfoId' - $ref: '#/components/parameters/ArtifactPathInNSD' @@ -465,7 +465,7 @@ paths: # PNF Descriptors # ############################################################################### /pnf_descriptors: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5 + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.5 parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization - $ref: ../components/SOL005_params.yaml#/components/parameters/Version @@ -556,7 +556,7 @@ paths: # Individual PNF Descriptor # ############################################################################### /pnf_descriptors/{pnfdInfoId}: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6 + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.6 parameters: - $ref: '#/components/parameters/PnfdInfoId' @@ -653,7 +653,7 @@ paths: # PNFD Archive Content # ############################################################################### /pnf_descriptors/{pnfdInfoId}/pnfd_content: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7 + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.7 parameters: - $ref: '#/components/parameters/PnfdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -736,7 +736,7 @@ paths: # PNFD # ############################################################################### /pnf_descriptors/{pnfdInfoId}/pnfd: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7a + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.7a parameters: - $ref: '#/components/parameters/PnfdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -777,7 +777,7 @@ paths: # PNFD Archive Manifest # ############################################################################### /pnf_descriptors/{pnfdInfoId}/manifest: - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7b + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.7b parameters: - $ref: '#/components/parameters/PnfdInfoId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -829,7 +829,7 @@ paths: # Individual PNFD Archive Artifact # ############################################################################### /pnf_descriptors/{pnfdInfoId}/artifacts/{artifactPath}: - #ETSI GS NFV-SOL 005 V3.5.1 location: 5.4.7c + #ETSI GS NFV-SOL 005 V5.2.1 location: 5.4.7c parameters: - $ref: '#/components/parameters/PnfdInfoId' - $ref: '#/components/parameters/ArtifactPathInPNFD' diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index be57538..b1c8f5c 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -743,4 +743,4 @@ components: explode: false schema: type: string - content: {} \ No newline at end of file + content: {} diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index fdf6991..d8865a6 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -203,14 +203,11 @@ paths: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization post: description: | - The POST method instantiates an NS instance. + The POST method instantiates an NS instance. See clause 6.4.4.3.1. In case of the "feasibilityCheckReserve" attribute is present, the method runs the feasibility check procedure for an NS instantiation scheduled operation or runs the feasibility checking procedure followed by the execution of the subsequent (actual) NS instantiation operation. - This method shall follow the provisions specified in the tables 6.4.4.3.1-1 - and 6.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 6.4.1.2. Before the NFVO initiates the "Instantiate NS" operation it shall verify @@ -298,15 +295,12 @@ paths: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization post: description: | - The POST method updates an NS instance. + The POST method updates an NS instance. See clause 6.4.6.3.1. In case of the "feasibilityCheckReserve" attribute is present, the NFVO runs the feasibility check procedure for an NS updating scheduled operation or runs the feasibility checking procedure followed by the execution of the subsequent (actual) NS updating operation. - This method shall follow the provisions specified in the tables - 6.4.6.3.1-1 and 6.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 6.4.1.2. If the "Update NS" operation involves adding a VNF instance, a @@ -2711,4 +2705,4 @@ components: style: simple explode: false schema: - type: string \ No newline at end of file + type: string diff --git a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml index 34a3352..da7dc6f 100644 --- a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +++ b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml @@ -1342,16 +1342,16 @@ definitions: type: boolean McioInfo: - description: - 'This type provides information about an MCIO representing the set of VNFC instances realized by one or a set of + description: > + This type provides information about an MCIO representing the set of VNFC instances realized by one or a set of OS containers which have been created based on the same VDU. - NOTE 1 The type of MCIO as specified in the declarative descriptor of the MCIO, and that can be read from the CISM. - EXAMPLE: In case of MCIOs managed by Kubernetes, the type of MCIO corresponds to the “kind” property of the declarative descriptor. - NOTE 2 If the attribute additionalInfo is present, it may contain runtime information on the actual and desired state of the MCIO(s). - NOTE 3 When the container infrastructure service is a Kubernetes® instance, the mcioId is the combined values from the kind - and name fields of the Kubernetes® resource object, separated by a slash. Example: "Deployment/abcd". - NOTE 4 When the container infrastructure service is a Kubernetes® instance, the mcioName is the name field of the resource object.' + NOTE 1: The type of MCIO as specified in the declarative descriptor of the MCIO, and that can be read from the CISM. + EXAMPLE 1: In case of MCIOs managed by Kubernetes, the type of MCIO corresponds to the “kind” property of the declarative descriptor. + NOTE 2: If the attribute additionalInfo is present, it may contain runtime information on the actual and desired state of the MCIO(s). + NOTE 3: When the container infrastructure service is a Kubernetes® instance, the mcioId is the combined values from the kind and name fields of the Kubernetes® resource object, separated by a slash. + EXAMPLE 2: "Deployment/abcd". + NOTE 4: When the container infrastructure service is a Kubernetes® instance, the mcioName is the name field of the resource object. type: object required: - mcioId @@ -3405,6 +3405,7 @@ definitions: type: object required: - vnfProfileId + - locationConstraints properties: vnfProfileId: description: > @@ -3416,7 +3417,7 @@ definitions: Defines the location constraints for the VNF instance to be created based on the VNF profile. - See note 1 and 2. + See notes 1 and 2. $ref: "#/definitions/LocationConstraints" vnfConstituentLocationConstraints: description: > @@ -7574,8 +7575,8 @@ definitions: ChangeVnfPackageData: description: | - This type specifies the information needed to change the current VNF package for a VNF instance. Clause B.3 of the - ETSI GS NFV-IFA 007 illustrates the variants of changes to the current VNF Package and information flow procedures. + This type specifies the information needed to change the current VNF package for a VNF instance. + Clause B.3 of ETSI GS NFV-IFA 007 illustrates the variants of changes to the current VNF Package and information flow procedures. This operation encompasses the following scenarios: * Changes of the VNF virtualised resources, such as requirements, composition and structure between the VNF versions, without changing the VNF software version. diff --git a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml index e03ca97..a42dbe0 100644 --- a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml +++ b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml @@ -29,7 +29,7 @@ paths: parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization - get: + post: description: | 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. @@ -54,7 +54,7 @@ paths: "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 - post: + 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. See clause 6.4.18.3.2. @@ -574,4 +574,4 @@ components: explode: false schema: type: string - content: {} \ No newline at end of file + content: {} diff --git a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml index 80177e5..9381719 100644 --- a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +++ b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml @@ -37,7 +37,7 @@ paths: # PM Jobs # ############################################################################### /pm_jobs: - #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2 + #ETSI GS NFV-SOL 005 V5.2.1 location: 7.4.2 parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization - $ref: ../components/SOL005_params.yaml#/components/parameters/Version @@ -124,7 +124,7 @@ paths: # Individual PM job # ############################################################################### /pm_jobs/{pmJobId}: - #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.3 + #ETSI GS NFV-SOL 005 V5.2.1 location: 7.4.3 parameters: - $ref: '#/components/parameters/PmJobId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -213,7 +213,7 @@ paths: # Individual performance report # ############################################################################### /pm_jobs/{pmJobId}/reports/{reportId}: - #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.4 + #ETSI GS NFV-SOL 005 V5.2.1 location: 7.4.4 parameters: - $ref: '#/components/parameters/PmJobId' - $ref: '#/components/parameters/ReportId' @@ -250,7 +250,7 @@ paths: # Thresholds # ############################################################################### /thresholds: - #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5 + #ETSI GS NFV-SOL 005 V5.2.1 location: 7.4.5 parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization - $ref: ../components/SOL005_params.yaml#/components/parameters/Version @@ -325,7 +325,7 @@ paths: # Individual threshold # ############################################################################### /thresholds/{thresholdId}: - #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.6 + #ETSI GS NFV-SOL 005 V5.2.1 location: 7.4.6 parameters: - $ref: '#/components/parameters/ThresholdId' - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization @@ -1502,4 +1502,4 @@ components: style: simple explode: false schema: - type: string \ No newline at end of file + type: string diff --git a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml index 5f87af1..12aa3ea 100644 --- a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml @@ -300,7 +300,7 @@ paths: put: description: | The PUT method provides the access configuration information for the NFVO to download the content of external - VNF package artifacts. See clause 9.4.4a.3.4. + VNF package artifacts. See clause 9.4.4a.3.3. parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType requestBody: @@ -417,10 +417,7 @@ paths: put: description: | - The PUT method uploads the content of a VNF package. - This method shall follow the provisions specified in the tables 9.4.5.3.3-1 - and 9.4.5.3.3-2 for URI query parameters, request and response data structures, - and response codes. + The PUT method uploads the content of a VNF package. See clause 9.4.5.3.3. Upon start of the upload of the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo" structure to "UPLOADING". Upon successful upload of the package, if the package references external artifacts, the NFVO shall obtain @@ -619,7 +616,7 @@ paths: get: description: | 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 9.4.7.3.2. + It can be used e.g. for resynchronization after error situations. See clause 9.4.8.3.2. parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept - in: query @@ -2195,4 +2192,4 @@ components: explode: false schema: type: string - content: {} \ No newline at end of file + content: {} -- GitLab