Commit b18c946d authored by Bertrand Souville's avatar Bertrand Souville
Browse files

Merge branch 'SOL005_V521_EditHelp_Feedback' into '5.2.3' 

SOL005_V521_CR122_EditHelpFeedback

See merge request !27
parents 469f019d a960fdf4

src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml

+2 −4
Original line number Diff line number Diff line
@@ -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

src/SOL005/NSDManagement/NSDManagement.yaml

+13 −13
Original line number Diff line number Diff line
@@ -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'

src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml

+3 −9
Original line number Diff line number Diff line
@@ -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

src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml

+12 −11
Original line number Diff line number Diff line
@@ -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.

src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml

+3 −3
Original line number Diff line number Diff line
@@ -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.