Commit 65f7db9d authored by Francesca Moscatelli's avatar Francesca Moscatelli
Browse files

Merge branch '3.5.1-dev' of https://forge.etsi.org/gitlab/nfv/SOL002-SOL003 into 3.5.1-dev

parents af28be21 90eb98f3

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+4 −4
Original line number Diff line number Diff line
@@ -31,9 +31,9 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      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.

        The API consumer can use this method to read configuration information about a VNF instance and/or its VNFC instances.

        See clause 9.4.2.3.2.

      responses:

        "200":

          $ref: '#/components/responses/Configuration.Get'
@@ -61,8 +61,8 @@ paths: 
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504



    patch:

      summary: Modify VNF/VNFC configuration.

      description: This method sets or modifies a configuration resource.

      description: |

        This method sets or modifies a configuration resource. See clause 9.4.2.3.4.

      requestBody:

        $ref: '#/components/requestBodies/ConfigurationRequest'

      responses:

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+11 −17
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The client can use this method to retrieve information about the alarm list.

        The API consumer can use this method to retrieve information about the alarm list. See clause 7.4.2.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -73,7 +73,7 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The client can use this method to read an individual alarm.

        The API consumer can use this method to read an individual alarm. See clause 7.4.3.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -107,7 +107,7 @@ paths: 


    patch:

      description: |

        This method modifies an individual alarm resource.

        This method modifies an individual alarm resource. See clause 7.4.3.3.4.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -152,9 +152,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    post:

      description: |

        The POST method enables the consumer to escalate the perceived severity of an alarm that is represented by an

        individual alarm resource. As the result of successfully executing this method, a new "Individual  subscription"

        resource as defined in clause 7.4.5 shall have been created.  This method shall not trigger any notification.

        The POST method enables the API consumer to escalate the perceived severity of an alarm that is represented

        by an individual alarm resource. See clause 7.4.4.3.1.

      requestBody:

        $ref: '#/components/requestBodies/IndividualAlarmEscalateRequest'

      responses:
@@ -191,8 +190,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The client can use this method to retrieve the list of active subscriptions for VNF alarms subscribed by the

        client. It can be used e.g. for resynchronization after error situations.

        The API consumer can use this method to retrieve the list of active subscriptions for VNF alarms subscribed

        by the API consumer. It can be used e.g. for resynchronization after error situations. See clause 7.4.5.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -228,7 +227,7 @@ paths: 


    post:

      description: |

        The POST method creates a new subscription.

        The POST method creates a new subscription. See clause 7.4.5.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -271,7 +270,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The client can use this method for reading an individual subscription for VNF alarms subscribed by the client.

        The API consumer can use this method for reading an individual subscription for VNF alarms subscribed

        by the API consumer. See clause 7.4.6.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -305,13 +305,7 @@ paths: 


    delete:

      description: |

        This method terminates an individual subscription. 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.4.6.3.5.

      responses:

        "204":

          $ref: '#/components/responses/IndividualSubscription.Delete'

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+9 −12
Original line number Diff line number Diff line
@@ -29,8 +29,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The GET method allows the server to test the notification endpoint that is provided by the client,

        e.g. during subscription.

        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 7.4.7.3.2.

      responses:

        "204":

          $ref: '#/components/responses/VNFFMNotification.Get'
@@ -51,9 +51,8 @@ paths: 


    post:

      description: |

        Notify

        The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have

        previously created an "Individual  subscription" resource with a matching filter.

        previously created an "Individual subscription" resource with a matching filter. See clause 7.4.7.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType

      requestBody:
@@ -82,8 +81,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The GET method allows the server to test the notification endpoint that is provided by the client,

        e.g. during subscription.

        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 7.4.7.3.2.

      responses:

        "204":

          $ref: '#/components/responses/VNFFMNotification.Get'
@@ -104,9 +103,8 @@ paths: 


    post:

      description: |

        Notify

        The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have

        previously created an "Individual  subscription" resource with a matching filter.

        previously created an "Individual subscription" resource with a matching filter. See clause 7.4.7.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType

      requestBody:
@@ -135,8 +133,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        The GET method allows the server to test the notification endpoint that is provided by the client,

        e.g. during subscription.

        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 7.4.7.3.2.

      responses:

        "204":

          $ref: '#/components/responses/VNFFMNotification.Get'
@@ -157,9 +155,8 @@ paths: 


    post:

      description: |

        Notify

        The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have

        previously created an "Individual  subscription" resource with a matching filter.

        previously created an "Individual subscription" resource with a matching filter. See clause 7.4.7.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType

      requestBody:

src/SOL002/VNFIndicator/VNFIndicator.yaml

+9 −36
Original line number Diff line number Diff line
@@ -34,9 +34,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Query multiple indicators

      description: Get a list of indicators. Support of attribute based filtering

        via query parameters.

      description: |

        The GET method queries multiple VNF indicators. See clause 8.4.2.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
@@ -74,10 +73,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Query multiple indicators related to a VNF instance.

      description: |

        Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query

        parameters.

        The GET method queries multiple VNF indicators related to a VNF instance. See clause 8.4.3.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
@@ -116,11 +113,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Read an inidividual VNF indicator related to a VNF instance.

      description: |

        Read an individual VNF indicator related to a specific VNF instance. NOTE: This identifier can be retrieved

        from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF

        instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        The GET method reads a VNF indicator. See clause 8.4.4.3.2.

      responses:

        "200":

          $ref: '#/components/responses/VnfIndividualIndicator.Get'
@@ -154,10 +148,9 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Query multiple subscriptions.

      description: |

        Service Unavailable

        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.

        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 8.4.5.3.2.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
@@ -190,19 +183,8 @@ paths: 
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504



    post:

      summary: Create a new subscription to VNF indicator change notifications

      description: |

        This method creates a new subscription. As the result of successfully executing this method, a new "Individual

        subscription" resource as defined in clause 8.4.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 VNFM, and might make

        sense only in very rare use cases. Consequently, the API producer 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). This method shall follow

        the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters, request and response

        data structures, and response codes

        The POST method creates a new subscription. See clause 8.4.5.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -244,10 +226,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Read an individual subscription.

      description: |

        Service Unavailable

        This resource represents an individual subscription. The client can use this resource to read and to terminate a subscription to notifications related to VNF indicator value changes.

        The GET method reads an individual subscription. See clause 8.4.6.3.2.

      responses:

        "200":

          $ref: '#/components/responses/VnfIndicatorSubscription.Get'
@@ -277,15 +257,8 @@ paths: 
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504



    delete:

      summary: Delete a subscription

      description: |

        This method terminates an individual subscription. 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:\tDue to race conditions, some notifications might still be received

        by the formerly-subscribed API consumer for a certain time period after

        the deletion.

        The DELETE method terminates an individual subscription. See clause 8.4.6.3.5.

      responses:

        "204":

          $ref: '#/components/responses/VnfIndicatorSubscription.Delete'

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+8 −18
Original line number Diff line number Diff line
@@ -31,11 +31,9 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Test notification endpoint.

      description: |

        Service Unavailable

        The GET method allows the server to test the notification endpoint that is provided by the client,

        e.g. during subscription.

        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 8.4.7.3.2.

      responses:

        "204":

          $ref: '#/components/responses/VNFInNotification.Get'
@@ -55,12 +53,9 @@ paths: 
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503



    post:

      summary: Notification endpoint

      description: |

        The API producer can use this resource to send notifications related to VNF indicator value changes to a

        subscribed API consumer, which has provided the URI of this resource during the subscription process.

        The POST method delivers a notification from API producer to an API consumer. The API  consumer shall have

        previously created an "Individual subscription" resource with a  matching filter.

        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 8.4.7.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType

      requestBody:
@@ -88,11 +83,9 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      summary: Test notification endpoint.

      description: |

        Service Unavailable

        The GET method allows the server to test the notification endpoint that is provided by the client,

        e.g. during subscription.

        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 8.4.7.3.2.

      responses:

        "204":

          $ref: '#/components/responses/VNFInNotification.Get'
@@ -112,12 +105,9 @@ paths: 
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503



    post:

      summary: Notification endpoint

      description: |

        The API producer can use this resource to send notifications related to VNF indicator value changes to a

        subscribed API consumer, which has provided the URI of this resource during the subscription process.

        The POST method delivers a notification from API producer to an API consumer. The API  consumer shall have

        previously created an "Individual subscription" resource with a  matching filter.

        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 8.4.7.3.1.

      parameters:

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType

      requestBody: