Commit 9878619e authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Merge branch '3.7.1-dev' into 'master' 

merge 3.7.1-dev

Closes #2 and #3

See merge request nfv/SOL011!2
parents 39fd041f f5ff7867

src/SOL011/APIVersion/APIVersion.yaml

+3 −3
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ info: 
    refers to and has not been approved by the ETSI NFV ISG. In case of

    discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to

    https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

    https://forge.etsi.org/rep/nfv/SOL011/-/issues



  license:

    name: ETSI Forge copyright notice
@@ -23,8 +23,8 @@ info: 
    name: NFV-SOL WG



externalDocs:

  description: ETSI GS NFV-SOL 011 V3.3.1

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

  description: ETSI GS NFV-SOL 011 V3.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/011/03.07.01_60/gs_NFV-SOL011v030701p.pdf



paths:

  /nsd/api_versions:

src/SOL011/NSDManagement/NSDManagement.yaml

+6 −6
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ info: 
    version of the ETSI Group Specification it refers to and has not been

    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI

    Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL011/-/issues

  license:

    name: "ETSI Forge copyright notice"

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info: 
    name: "NFV-SOL WG"



externalDocs:

  description: ETSI GS NFV-SOL 011 V3.3.1

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

  description: ETSI GS NFV-SOL 011 V3.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/011/03.07.01_60/gs_NFV-SOL011v030701p.pdf



basePath: /nsd/v1
@@ -34,7 +34,7 @@ produces: 


paths:

  "/api_versions":

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml#/paths/~1api-versions'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml#/paths/~1api_versions'



  "/ns_descriptors":

    parameters:
@@ -52,7 +52,7 @@ paths: 
        required: true

        type: string

    get:

      $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSDManagement/NSDManagement.yaml#/paths/~1ns_descriptors/get'

      $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSDManagement/NSDManagement.yaml#/paths/~1ns_descriptors/get'



  '/ns_descriptors/{nsdInfoId}':

    parameters:
@@ -76,5 +76,5 @@ paths: 
        required: true

        type: string

    get:

      $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSDManagement/NSDManagement.yaml#/paths/~1ns_descriptors~1{nsdInfoId}/get'

      $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSDManagement/NSDManagement.yaml#/paths/~1ns_descriptors~1{nsdInfoId}/get'

src/SOL011/NSFaultManagement/NSFaultManagement.yaml

+8 −8
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ info: 
    version of the ETSI Group Specification it refers to and has not been

    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI

    Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL011/-/issues

  license:

    name: "ETSI Forge copyright notice"

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -17,8 +17,8 @@ info: 
    name: "NFV-SOL WG"



externalDocs:

  description: ETSI GS NFV-SOL 011 V3.3.1

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

  description: ETSI GS NFV-SOL 011 V3.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/011/03.07.01_60/gs_NFV-SOL011v030701p.pdf



basePath: /nsfm/v1
@@ -34,12 +34,12 @@ produces: 


paths:

  "/api_versions":

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1api-versions'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1api_versions'

  "/alarms":

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1alarms'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1alarms'

  "/alarms/{alarmId}":

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1alarms~1{alarmId}'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1alarms~1{alarmId}'

  "/subscriptions":

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1subscriptions'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1subscriptions'

  "/subscriptions/{subscriptionId}":

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1subscriptions~1{subscriptionId}'
 
    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagement/NSFaultManagement.yaml#/paths/~1subscriptions~1{subscriptionId}'
 
 No newline at end of file

src/SOL011/NSFaultManagementNotification/NSFaultManagementNotification.yaml

+5 −5
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ info: 
    version of the ETSI Group Specification it refers to and has not been

    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI

    Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL011/-/issues

  license:

    name: "ETSI Forge copyright notice"

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
@@ -18,7 +18,7 @@ info: 


externalDocs:

  description: ETSI GS NFV-SOL 011 V3.3.1

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

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/011/03.07.01_60/gs_NFV-SOL011v030701p.pdf



basePath: /callback/v1
@@ -34,8 +34,8 @@ produces: 


paths:

  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml#/paths/~1URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml#/paths/~1URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification'

  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml#/paths/~1URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification'

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml#/paths/~1URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification'

  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':

    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/raw/v2.6.1/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml#/paths/~1URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification'
 
    $ref: 'https://forge.etsi.org/rep/nfv/SOL005/-/raw/2.6.1-maintenance/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml#/paths/~1URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification'

src/SOL011/NSInstanceUsageNotification/NSInstanceUsageNotification.yaml

+38 −165
Original line number Diff line number Diff line
@@ -8,13 +8,13 @@ info: 
    IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification

     it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.



    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL011/-/issues

  license:

    name: ETSI Forge copyright notice

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:

  description: ETSI GS NFV-SOL 011 V3.3.1

  url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL011ed331_Or-Or_Stage_3/NFV-SOL011ed331v020.zip

  description: ETSI GS NFV-SOL 011 V3.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/011/03.07.01_60/gs_NFV-SOL011v030701p.pdf



security:

  - OauthSecurity:
@@ -74,8 +74,8 @@ paths: 
        - $ref: "../components/SOL011_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL011_params.yaml#/components/parameters/Accept"

        - $ref: "../components/SOL011_params.yaml#/components/parameters/Authorization"

        - $ref: "../components/SOL011_params.yaml#/components/parameters/filter"

        - $ref: "../components/SOL011_params.yaml#/components/parameters/nextpage_opaque_marker"

        - $ref: "#/components/parameters/filter.Subscriptions"

        - $ref: "#/components/parameters/nextpage_opaque_marker.Subscriptions"

      responses:

        201:

          $ref: "#/components/responses/Subscriptions.Get.200"
@@ -250,6 +250,33 @@ components: 
      schema:

        $ref: '../components/SOL011_schemas.yaml#/components/schemas/Identifier'



    filter.Subscriptions:

      name: filter

      description: >

        Attribute-based filtering expression according to clause 5.2 of ETSI

        GS NFV-SOL 013 [2].

        The NFVO-C shall support receiving this parameter as part of the URI query

        string. The NFVO-N may supply this parameter.

        All attribute names that appear in the NsInstanceUsageSubscription and in

        data types referenced from it shall be supported by the NFVO-C in the filter

        expression.

      in: query

      required: false

      schema:

        type: string



    nextpage_opaque_marker.Subscriptions:

      name: nextpage_opaque_marker

      description: >

        Marker to obtain the next page of a paged response. Shall be supported by

        the NFVO-C if the NFVO-C supports alternative 2 (paging) according to

        clause 5.4.2.1 of ETSI GS NFV-SOL 013 [2] for this resource

      in: query

      required: false

      schema:

        type: string





  requestBodies:

    NsInstanceUsageSubscriptionRequest:

      description:
@@ -257,7 +284,7 @@ components: 
      content:

        application/json:

          schema:

            $ref: "#/components/schemas/NsInstanceUsageSubscriptionRequest"

            $ref: "definitions/NSInstanceUsageNotification_def.yaml#/definitions/schemas/NsInstanceUsageSubscriptionRequest"



    NsInstanceUsageNotification:

      description:
@@ -266,7 +293,7 @@ components: 
      content:

        application/json:

          schema:

            $ref: "#/components/schemas/NsInstanceUsageNotification"

            $ref: "definitions/NSInstanceUsageNotification_def.yaml#/definitions/schemas/NsInstanceUsageNotification"



  responses:

    Subscriptions.Post.201:
@@ -297,7 +324,7 @@ components: 
      content:

        application/json:

          schema:

            $ref: '#/components/schemas/NsInstanceUsageSubscription'

            $ref: 'definitions/NSInstanceUsageNotification_def.yaml#/definitions/schemas/NsInstanceUsageSubscription'

    

    Subscriptions.Post.303:

      description: >-
@@ -357,7 +384,7 @@ components: 
          schema:

            type: array

            items:

              $ref: "#/components/schemas/NsInstanceUsageSubscription"

              $ref: "definitions/NSInstanceUsageNotification_def.yaml#/definitions/schemas/NsInstanceUsageSubscription"



    Subscription.Get.200:

      description: >-
@@ -381,7 +408,7 @@ components: 
      content:

        application/json:

          schema:

            $ref: '#/components/schemas/NsInstanceUsageSubscription'

            $ref: 'definitions/NSInstanceUsageNotification_def.yaml#/definitions/schemas/NsInstanceUsageSubscription'



    Subscription.Delete.204:

      description: >-
@@ -436,157 +463,3 @@ components: 
            Version of the API used in the response.

          schema:

            type: string
 
 No newline at end of file
 


  schemas:

    NsInstanceUsageSubscriptionRequest:

      description: >-

        This type represents a subscription request related to notifications about NS 

        instance usage. It shall comply with the provisions defined in table 8.6.2.2-1.

      type: object

      required:

        - callbackUri

      properties:

        filter:

          description: >-

            Filter settings for this subscription, to define the subset of all notifications 

            this subscription relates to. A particular notification is sent to the subscriber 

            if the filter matches, or if there is no filter.

          $ref: "#/components/schemas/NsInstanceUsageNotificationsFilter"

        callbackUri:

          description: >-

            The URI of the endpoint to send the notification to.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/Uri"

        authentication:

          description: >-

            Authentication parameters to configure the use of Authorization when sending 

            notifications corresponding to this subscription, as defined in clause 8.3.4 

            of ETSI GS NFV-SOL 013.

            

            This attribute shall only be present if the subscriber requires authorization 

            of notifications.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/SubscriptionAuthentication"



    NsInstanceUsageSubscription:

      description: >-

        This type represents a subscription related to notifications about NS instance usage. 

        It shall comply with the provisions defined in table 8.6.2.3-1.

      type: object

      required:

        - id

        - callbackUri

        - _links

      properties:

        id:

          description: >-

            Identifier that identifies the subscription.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/Identifier"

        filter:

          description: >-

            Filter settings for this subscription, to define the subset of all notifications 

            this subscription relates to. A particular notification is sent to the subscriber 

            if the filter matches, or if there is no filter.

          $ref: "#/components/schemas/NsInstanceUsageNotificationsFilter"

        callbackUri:

          description: >-

            The URI of the endpoint to send the notification to.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/Uri"

        _links:

          description: >-

            Links to resources related to this resource.

          type: object

          required:

            - self

          properties:

            self: 

              description: >-

                URI of this resource.

              $ref: "../components/SOL011_schemas.yaml#/components/schemas/Link"

    

    NsInstanceUsageNotification:

      description: >-

        This type represents an NS instance usage notification, which indicates the start 

        or end of usage of an NS instance as a part of a composite NS managed by the NFVO-C. 

        It shall comply with the provisions defined in table 8.6.2.4-1.

      type: object

      required:

        - id

        - notificationType

        - subscriptionId

        - timeStamp

        - nsInstanceId

        - status

        - _links

      properties:

        id:

          description: >-

            Identifier of this notification. If a notification is sent multiple times due 

            to multiple subscriptions, the "id" attribute of all these notifications shall 

            have the same value.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/Identifier"

        notificationType:

          description: >-

            Discriminator for the different notification types. Shall be set to 

            "NsInstanceUsageNotification" for this notification type.

          type: string

        subscriptionId:

          description: >-

            Identifier of the subscription that this notification relates to.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/Identifier"

        timeStamp:

          description: >-

            Date and time of the generation of the notification.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/DateTime"

        nsInstanceId:

          description: >-

            Identifier of the NS instance affected.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/Identifier"

        status:

          description: >-

            Indicates whether this notification reports about the start of the usage of 

            an NS instance or about the end of the usage of an NS instance.

          $ref: "#/components/schemas/NsInstanceUsageStatusType"

        _links:

          description: >-

            Links to resources related to this notification.

          $ref: "../components/SOL011_schemas.yaml#/components/schemas/NotificationLink"



    NsInstanceUsageNotificationsFilter:

      description: >-

        This type represents a subscription filter related to notifications about NS 

        instance usage. It shall comply with the provisions defined in table 8.6.3.1-1. 

      type: object

      properties:

        notificationTypes:

          description: >-

            Match particular notification types. 

            

            Permitted values:

            - NsInstanceUsageNotification



            NOTE: The permitted values of the "notificationTypes" attribute are spelled 

            exactly as the names of the notification types to facilitate automated code 

            generation systems.

          type: array

          items:

            type: string

            enum:

            - NsInstanceUsageNotification

        nsInstanceId:

          description: >-

            If present, match NS instances with an instance identifier listed in this attribute.

          type: array

          items:

            $ref: "../components/SOL011_schemas.yaml#/components/schemas/Identifier"

        status:

          description: >-

            If present, match a particular status of usage of an NS instance.

          $ref: "#/components/schemas/NsInstanceUsageStatusType"

    

    NsInstanceUsageStatusType:

      description: >-

        The enumeration NsInstanceUsageStatusType shall comply with the provisions defined 

        in table 8.6.4.3-1.

      type: string

      enum:

        - START

        - END