Commit 219efa71 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

implemented udpates for SOL005ed351 v3.3.8

parent 648d4c0f
Loading
Loading
Loading
Loading
+43 −18
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ paths:
        500:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        503:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
          $ref: '#/components/responses/CoordinationActions.Post.503'
        504:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

@@ -172,9 +172,9 @@ components:
      description: |
        201 CREATED

        Shall be returned when the API producer has chosen the synchronous mode, which may be 
        chosen for coordination actions that finish within the time frame in which an HTTP 
        response is expected.
        Shall be returned  to indicate a finished coordination action when the API producer has chosen the synchronous
        mode, which may be selected for coordination actions that finish within the time frame in which an HTTP
        response is expected..
        
        The response body shall contain an LcmCoord data structure that represents the result 
        of the coordination action.
@@ -226,6 +226,11 @@ components:
        The HTTP response shall include a "Location" HTTP header that indicates the 
        URI of the "Individual coordination action" resource that will be created 
        once the coordination operation has finished successfully.

        Further, the HTTP response may include a "Retry-After" HTTP header that indicates the time to wait before
        sending the next GET request to the "individual coordination" resource indicated in the "Location" header.
        If the header is provided, the NFVO shall record the signalled delay value in the "delay" attribute of the
        applicable entry in the "lcmCoordinations" array in the "NsLcmOpOcc" structure.
      headers:
        Version:
          description: The used API version.
@@ -255,14 +260,22 @@ components:
          schema:
            type: string

    IndividualCoordinationAction.Get.200:
    CoordinationActions.Post.503:
      description: |
        200 OK
        503 Service Unavailable

        Shall be returned when the coordination is finished and the coordination result 
        has been read successfully.
        A representation of the "Individual coordination action" resource shall be returned 
        in the response body.
        Shall be returned upon the following error: The API producer has chosen the synchronous mode and cannot perform
        the requested coordination currently, but expects to be able to perform it sometime in the future.

        No "individual coordination action" resource shall be created.

        A ProblemDetails structure shall be included in the response to provide more details about the rejection
        in the "details" attribute.

        The HTTP response shall include a "Retry-After" HTTP header that indicates the delay after which it is
        suggested to repeat the coordination request with the same set of parameters. The NFVO shall record the
        signalled delay value in the "delay" attribute of the applicable entry in the "rejectedLcmCoordinations"
        array in the "NsLcmOpOcc" structure.
      headers:
        Version:
          description: The used API version.
@@ -278,6 +291,15 @@ components:
          explode: false
          schema:
            type: string
        Retry-After:
          description: |
            It indicates the delay after which it is suggested to repeat the coordination request with the same
            set of parameters.
          style: simple
          explode: false
          schema:
            type: string
            format: url
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
@@ -287,17 +309,16 @@ components:
      content:
        application/json:
          schema:
            $ref: definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoord
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualCoordinationAction.Post.202:
    IndividualCoordinationAction.Get.200:
      description: |
        202 ACCEPTED

        Shall be returned when the management operation with which coordination is requested 
        is still ongoing or in the process of being cancelled, i.e. no coordination result is
        available yet.
        200 OK

        The response body shall be empty.
        Shall be returned when the coordination is finished and the coordination result 
        has been read successfully.
        A representation of the "Individual coordination action" resource shall be returned 
        in the response body.
      headers:
        Version:
          description: The used API version.
@@ -319,6 +340,10 @@ components:
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoord

    CoordinationActionCancel.Post.202:
      description: |
+64 −14
Original line number Diff line number Diff line
@@ -4016,6 +4016,7 @@ definitions:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          -	NsLcmCapacityShortageNotification
          - NsChangeNotification

          See note.
@@ -4051,6 +4052,14 @@ definitions:
        type: array
        items:
          $ref: "#/definitions/LcmOperationStateType"
      affectedNsInstanceIds:
        description: >
          Match particular identifiers of the NS instance(s) related to the operation occurrence that were affected by
          the shortage as reported in notifications of type NsLcmCapacityShortageNotification.
          May be present if the "notificationTypes" attribute contains the value "NsLcmCapacityShortageNotification",
          and shall be absent otherwise.
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsComponentTypes:
        description: >
          Match particular NS component types for the
@@ -4454,6 +4463,9 @@ definitions:
      NOTE 2:	A coordination action has timed out if the NFVO has not been able to read the "Individual coordination
      action" resource within a timeout interval after requesting the coordination to be started or to be cancelled.
      The length of the timeout interval is defined by means outside the scope of the present document

      NOTE 3:	The list of rejected coordinations may be garbage collected if the LCM operation occurrence has reached
      a terminal state, i.e. one of "COMPLETED", "FAILED", “PARTIALLY COMPLETED” and "ROLLED_BACK".
    type: object
    required:
      - id
@@ -4611,7 +4623,7 @@ definitions:

      lcmCoordinations:
        description: >
          Information about LCM coordination actions (see clause 12.5.4.3)
          Information about LCM coordination actions (see clause 12)
          related to this LCM operation occurrence.
        type: array
        items:
@@ -4631,7 +4643,6 @@ definitions:
                  of the "202 Accepted" HTTP response to the POST request that has initiated the
                  coordination action (see clause 12.4.2.3.1).
                $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

              coordinationActionName:
                description: >
                  Indicator of the actual coordination action.
@@ -4646,12 +4657,13 @@ definitions:

              startTime:
                description: >
                  The time when the coordination action has been started.
                  The time when the NFVO has received the confirmation that the coordination action has been started.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
              endTime:
                description: >
                  The end time of the coordination action. Shall be present for a coordination
                  action that has finished or timed out (see note 2) and shall be absent if the
                  The time when the NFVO has received the confirmation that the coordination action has finished or
                  has been cancelled, or the time when a coordination action has timed out. Shall be present for a
                  coordination action that has finished or timed out (see note 2) and shall be absent if the
                  coordination is ongoing.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
              endpointType:
@@ -4662,6 +4674,12 @@ definitions:
                type: string
                enum:
                  - MGMT
              delay:
                description: >
                  The end of the delay period.
                  This attribute shall be present if the last known HTTP response related to this coordination has
                  contained a "Retry-After" header, and shall be absent otherwise.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
              warnings:
                description: >
                  Warning messages that were generated while the operation was executing.
@@ -4672,7 +4690,39 @@ definitions:
                type: array
                items:
                  type: string

      rejectedLcmCoordinations:
        description: >
          Information about LCM coordination actions (see clause 12) that were rejected by 503 error which means
          they can be tried again after a delay. See note 3.
        type: array
        items:
          type: object
          required:
            - coordinationActionName
            - rejectionTime
            - endpointType
            - delay
          properties:
            coordinationActionName:
              description: >
                Indicator of the actual coordination action.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
            rejectionTime:
              description: >
                The time when the NFVO has received the 503 response that rejects the actual coordination.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
            endpointType:
              description: >
                The endpoint type used by this coordination action.
                Valid values:
                -	MGMT: coordination with other operation supporting management systems (e.g. OSS/BSS)
              type: string
                enum:
                  - MGMT
            delay:
              description: >
                The end of the delay period, as calculated from the startTime and "Retry-After" header.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      _links:
        description: >
          Links to resources related to this resource.
+110 −2
Original line number Diff line number Diff line
@@ -195,6 +195,61 @@ paths:
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503

  /URI_is_provided_by_the_client_when_creating_the_subscription-NsLcmCapacityShortageNotification:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    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.1.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        "204":
          $ref: '#/components/responses/NsLcmCapacityShortageNotification.Get'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503

    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.
        See clause 6.4.18.3.1.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsLcmCapacityShortageNotificationRequest'
      responses:
        "204":
          $ref: '#/components/responses/NsLcmCapacityShortageNotification.Post'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
components:
  requestBodies:
    NsLcmOperationOccurrenceNotificationRequest:
@@ -224,6 +279,15 @@ components:
            $ref: ./definitions/SOL005NSLifecycleManagementNotification_def.yaml#/definitions/NsIdentifierDeletionNotification
      required: true

    NsLcmCapacityShortageNotificationRequest:
      description: |
        A notification about lifecycle capacity shortage triggered when there is a shortage condition.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSLifecycleManagementNotification_def.yaml#/definitions/NsLcmCapacityShortageNotification
      required: true

  responses:
    NsLcmOperationOccurrenceNotification.Get:
      description: |
@@ -357,3 +421,47 @@ components:
          schema:
            type: string
      content: {}

    NsLcmCapacityShortageNotification.Get:
      description: |
        204 No Content
        Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    NsLcmCapacityShortageNotification.Post:
      description: |
        204 No Content
        Shall be returned when the notification has been delivered successfully.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}
 No newline at end of file
+205 −0

File changed.

Preview size limit exceeded, changes collapsed.