Commit 7b7dee37 authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

fix issue #3 - redefine global query parameters in SOL003 locally

parent a5755264

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

+49 −18
Original line number Diff line number Diff line
@@ -42,10 +42,10 @@ paths: 
      description: |

        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

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

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

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

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

        - $ref: '#/components/parameters/filter_alarm_list'

        - $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm

      responses:

        200:

          $ref: '#/components/responses/Alarms.Get.200'
@@ -77,10 +77,10 @@ paths: 
    #SOL003 location: 7.4.3

    parameters:

      - $ref: '#/components/parameters/AlarmId'

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

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

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

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

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

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

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

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

    get:

      description: |

        The API consumer can use this method to read an individual alarm. See clause 7.4.3.3.2.
@@ -147,10 +147,10 @@ paths: 
  /subscriptions:

    #SOL003 location: 7.4.4

    parameters:

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

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

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

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

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

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

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

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

    post:

      description: |

        The POST method creates a new subscription. See clause 7.4.4.3.1.
@@ -187,8 +187,8 @@ paths: 
        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

        - $ref: '#/components/parameters/filter_subscriptions'

        - $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm

      responses:

        200:

          $ref: '#/components/responses/Subscriptions.Get.200'
@@ -220,15 +220,15 @@ paths: 
    #SOL003 location: 7.4.5

    parameters:

      - $ref: '#/components/parameters/SubscriptionId'

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

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

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

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

    get:

      description: |

        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

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

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

      responses:

        200:

          $ref: '#/components/responses/IndividualSubscription.Get.200'
@@ -283,6 +283,37 @@ paths: 


components:

  parameters:

    filter_alarm_list:

      name: filter

      description: >

        Attribute-based filtering expression according to clause 5.2 of ETSI

        GS NFV-SOL 013 [8].

        The VNFM shall support receiving this parameter as part of the URI query string.

        The NFVO may supply this parameter.

        The following attribute names shall be supported by the VNFM in the attribute based filtering

        expression: id, managedObjectId,

        rootCauseFaultyResource/faultyResourceType, eventType, perceivedSeverity,

        probableCause.

      in: query

      required: false

      schema:

        type: string



    filter_subscriptions:

      name: filter

      description: >

        Attribute-based filtering expression according to clause 5.2 of ETSI

        GS NFV-SOL 013 [8].

        The VNFM shall support receiving this parameter as part of the URI

        query string. The NFVO may supply this parameter.

        All attribute names that appear in the FmSubscription and in data types

        referenced from it shall be supported by the VNFM in the filter

        expression.

      in: query

      required: false

      schema:

        type: string



    AlarmId:

      name: alarmId

      in: path

src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+9 −9
Original line number Diff line number Diff line
@@ -33,14 +33,14 @@ paths: 
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification:

    #SOL003 location: 7.4.6

    parameters:

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

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

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

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

    post:

      description: |

        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

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

      requestBody:

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

      responses:
@@ -89,14 +89,14 @@ paths: 
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification:

    #SOL003 location: 7.4.6

    parameters:

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

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

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

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

    post:

      description: |

        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

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

      requestBody:

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

      responses:
@@ -145,14 +145,14 @@ paths: 
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification:

    #SOL003 location: 7.4.6

    parameters:

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

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

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

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

    post:

      description: |

        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

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

      requestBody:

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

      responses:

src/SOL003/VNFIndicator/VNFIndicator.yaml

+68 −25
Original line number Diff line number Diff line
@@ -43,11 +43,11 @@ paths: 
      description: |

        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

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

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

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

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

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

        - $ref: '#/components/parameters/filter_vnf_indicators'

        - $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm

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

      responses:

        200:

          $ref: '#/components/responses/Indicators.Get.200'
@@ -83,12 +83,12 @@ paths: 
      description: |

        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

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

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

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

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

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

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

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

        - $ref: '#/components/parameters/filter_vnf_indicators_related_to_vnf_instance'

        - $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm

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

      responses:

        200:

          $ref: '#/components/responses/VnfInstanceIndicators.Get.200'
@@ -125,10 +125,10 @@ paths: 
      description: |

        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

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

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

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

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

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

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

      responses:

        200:

          $ref: '#/components/responses/VnfInstanceIndividualIndicator.Get.200'
@@ -158,10 +158,10 @@ paths: 
  ###############################################################################

  /subscriptions:

    parameters:

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

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

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

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

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

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

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

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

    post:

      description: |

        The POST method creates a new subscription. See clause 8.4.5.3.1.
@@ -198,8 +198,8 @@ paths: 
        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

        - $ref: '#/components/parameters/filter_subscriptions'

        - $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm

      responses:

        200:

          $ref: '#/components/responses/Subscriptions.Get.200'
@@ -231,14 +231,14 @@ paths: 
    #SOL003 location: 8.4.6

    parameters:

      - $ref: '#/components/parameters/SubscriptionId'

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

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

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

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

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

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

    get:

      description: |

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

      parameters:

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

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

      responses:

        200:

          $ref: '#/components/responses/IndividualSubscription.Get.200'
@@ -292,6 +292,49 @@ paths: 


components:

  parameters:

    filter_vnf_indicators:

      name: filter

      description: >

        Attribute-based filtering expression according to clause 5.2 of ETSI

        GS NFV-SOL 013 [8].

        The VNFM shall support receiving this parameter as part of the URI query string.

        The NFVO may supply this parameter.

        All attribute names that appear in the VnfIndicator data type and in data types

        referenced from it shall be supported by the VNFM in the filter expression.

      in: query

      required: false

      schema:

        type: string



    filter_vnf_indicators_related_to_vnf_instance:

      name: filter

      description: >

        Attribute-based filtering expression according to clause 5.2 of ETSI

        GS NFV-SOL 013 [8].

        The VNFM shall support receiving this parameter as part of the URI query string.

        The NFVO may supply this parameter.

        All attribute names that appear in the VnfIndicator data type and in data types

        referenced from it shall be supported by the VNFM in the filter expression.

      in: query

      required: false

      schema:

        type: string



    filter_subscriptions:

      name: filter

      description: >

        Attribute-based filtering expression according to clause 5.2 of ETSI

        GS NFV-SOL 013 [8].

        The VNFM shall support receiving this parameter as part of the URI query string.

        The NFVO may supply this parameter.

        All attribute names that appear in the VnfIndicatorSubscription data type and in

        data types referenced from it shall be supported by the VNFM in the filter

        expression.

      in: query

      required: false

      schema:

        type: string



    VnfInstanceId:

      name: vnfInstanceId

      in: path

src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+4 −4
Original line number Diff line number Diff line
@@ -37,8 +37,8 @@ paths: 
        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

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

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

      requestBody:

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

      responses:
@@ -64,8 +64,8 @@ paths: 
        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

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

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

      responses:

        204:

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

src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+204 −91

File changed.

Preview size limit exceeded, changes collapsed.