Commit 10e52e7f authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated endpoints descriptions

parent 90eb98f3

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

+11 −48
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ info: 
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"



externalDocs:

  description: ETSI GS NFV-SOL 003 V3.3.4

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf

  description: ETSI GS NFV-SOL 003 V3.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf



servers:

  - url: http://127.0.0.1/vnffm/v1
@@ -39,10 +39,7 @@ paths: 
    #SOL003 location: 7.4.2

    get:

      description: |

        Get Alarm List.

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

        This method shall follow the provisions specified in the tables 7.4.2.3.2-1 and 7.4.2.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 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
@@ -85,9 +82,7 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    get:

      description: |

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

        This method shall follow the provisions specified in the tables 7.4.3.3.2-1 and 7.4.3.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      responses:

        200:

          $ref: '#/components/responses/IndividualAlarm.Get.200'
@@ -114,10 +109,7 @@ paths: 


    patch:

      description: |

        Acknowledge Alarm.

        This method modifies an "Individual alarm" resource.

        This method shall follow the provisions specified in the tables 7.4.3.3.4-1 and 7.4.3.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.4.3.3.4.

      requestBody:

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

      responses:
@@ -167,20 +159,7 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    post:

      description: |

        Subscribe.

        The POST method creates a new subscription.

        This method shall follow the provisions specified in the tables 7.4.4.3.1-1 and 7.4.4.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.4.5 shall have been created. This method shall not trigger any notification.

        Creation of two "Individual subscription" resources with the same callback URI and the same filter

        can result in performance degradation and will provide duplicates of notifications to the NFVO,

        and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating

        a new "Individual subscription" resource if another "Individual subscription" resource with the

        same filter and callback URI 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 callback URI).

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

      requestBody:

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

      responses:
@@ -222,12 +201,8 @@ paths: 


    get:

      description: |

        Query Subscription Information





        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.

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

      parameters:

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

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
@@ -266,11 +241,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization

    get:

      description: |

        Query Subscription Information.

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

        subscribed by the API consumer.

        This method shall follow the provisions specified in the tables 7.4.5.3.2-1 and 7.4.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 subscription for VNF

        alarms subscribed by the API consumer. See clause 7.4.5.3.2.

      parameters:

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

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


    delete:

      description: |

        Terminate Subscription.

        This method terminates an individual subscription.

        This method shall follow the provisions specified in the tables 7.4.5.3.5-1 and 7.4.5.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.4.5.3.5.

      responses:

        204:

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

src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+14 −29
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ info: 
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1



externalDocs:

  description: ETSI GS NFV-SOL 003 V3.3.4

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf

  description: ETSI GS NFV-SOL 003 V3.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf



servers:

  - url: http://127.0.0.1/callback/v1
@@ -36,11 +36,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    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.

        This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2

        for URI query parameters, request and response data structures, and response codes.

        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. See clause 7.4.6.3.1.

      parameters:

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

      requestBody:
@@ -65,10 +62,8 @@ paths: 


    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.

        This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      responses:

        204:

          $ref: '#/components/responses/AlarmNotification.Get.204'
@@ -97,11 +92,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    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.

        This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2

        for URI query parameters, request and response data structures, and response codes.

        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. See clause 7.4.6.3.1.

      parameters:

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

      requestBody:
@@ -126,10 +118,8 @@ paths: 


    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.

        This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      responses:

        204:

          $ref: '#/components/responses/AlarmClearedNotification.Get.204'
@@ -158,11 +148,8 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    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.

        This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2

        for URI query parameters, request and response data structures, and response codes.

        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. See clause 7.4.6.3.1.

      parameters:

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

      requestBody:
@@ -187,10 +174,8 @@ paths: 


    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.

        This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      responses:

        204:

          $ref: '#/components/responses/AlarmListRebuiltNotification.Get.204'

src/SOL003/VNFIndicator/VNFIndicator.yaml

+10 −47
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ info: 
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"



externalDocs:

  description: ETSI GS NFV-SOL 003 V3.3.4

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf

  description: ETSI GS NFV-SOL 003 V3.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf



servers:

  - url: http://127.0.0.1/vnfind/v1
@@ -40,10 +40,7 @@ paths: 
    #SOL003 location: 8.4.2

    get:

      description: |

        Get Indicator Value.

        The GET method queries multiple VNF indicators.

        This method shall follow the provisions specified in the tables 8.4.2.3.2-1 and 8.4.2.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      parameters:

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

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
@@ -83,10 +80,7 @@ paths: 
      - $ref: '#/components/parameters/VnfInstanceId'

    get:

      description: |

        Get Indicator Value.

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

        This method shall follow the provisions specified in the tables 8.4.3.3.2-1 and 8.4.3.3.2-2

        for URI query parameters, request and response data structures, and response codes.

        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/Accept

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -128,10 +122,7 @@ paths: 
      - $ref: '#/components/parameters/VnfInstanceId'

    get:

      description: |

        Get Indicator Value.

        The GET method reads a VNF indicator.

        This method shall follow the provisions specified in the tables 8.4.4.3.2-1 and 8.4.4.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      parameters:

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

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
@@ -172,20 +163,7 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    post:

      description: |

        Subscribe.

        The POST 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 callback URI and the same filter

        can result in performance degradation and will provide duplicates of notifications to the NFVO,

        and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating

        a new "Individual subscription" resource if another "Individual subscription" resource with the

        same filter and callback URI 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 callback URI).

        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.

      requestBody:

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

      responses:
@@ -227,11 +205,8 @@ paths: 


    get:

      description: |

        Query Subscription Information.

        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.

        This method shall follow the provisions specified in the tables 8.4.5.3.2-1 and 8.4.5.3.2-2

        for URI query parameters, request and response data structures, and response codes.

        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
@@ -271,10 +246,7 @@ paths: 
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version

    get:

      description: |

        Query Subscription Information.

        The GET method reads an individual subscription.

        This method shall follow the provisions specified in the tables 8.4.6.3.2-1 and 8.4.6.3.2-2

        for URI query parameters, request and response data structures, and response codes.

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

      parameters:

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

      responses:
@@ -303,16 +275,7 @@ paths: 


    delete:

      description: |

        Terminate Subscription.

        The DELETE method terminates an individual subscription.

        This method shall follow the provisions specified in the tables 8.4.6.3.5-1 and 8.4.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.

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

      responses:

        204:

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

src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+6 −11
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ info: 
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"



externalDocs:

  description: ETSI GS NFV-SOL 003 V3.3.4

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf

  description: ETSI GS NFV-SOL 003 V3.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf



servers:

  - url: http://127.0.0.1/callback/v1
@@ -33,11 +33,8 @@ paths: 
    #SOL003 location: 8.4.7

    post:

      description: |

        Notify.

        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.

        This method shall follow the provisions specified in the tables 8.4.7.3.1-1 and 8.4.7.3.1-2

        for URI query parameters, request and response data structures, and response codes.

        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/Authorization

        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
@@ -63,10 +60,8 @@ paths: 


    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.

        This method shall follow the provisions specified in the tables 8.4.7.3.2-1 and 8.4.7.3.2-2

        for URI query parameters, request and response data structures, and response codes.

        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.

      parameters:

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

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

src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+47 −345

File changed.

Preview size limit exceeded, changes collapsed.