3.6.1 dev

Merge request reports

Loading
+1 −1
Changes for docker/Dockerfile: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ RUN apk add asciidoctor
RUN apk add openjdk8
RUN apk add ca-certificates wget && update-ca-certificates 
RUN apk add openssl
RUN gem install rdoc --pre || gem install rdoc --pre
RUN gem install rdoc -v 6.3.3 || gem install rdoc -v 6.3.3
RUN gem install asciidoctor-pdf-cjk
RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar
RUN npm config set proxy $http_proxy
+2 −2
Changes for src/SOL002/APIVersion/APIVersion.yaml: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -19,8 +19,8 @@ info:
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 002 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.05.01_60/gs_NFV-SOL002v030501p.pdf
  description: ETSI GS NFV-SOL 002 V3.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf

paths:
  /vnfconfig/api_versions:
+4 −4
Changes for src/SOL002/VNFConfiguration/VNFConfiguration.yaml: 4 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -19,8 +19,8 @@ info:
  version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 002 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.05.01_60/gs_NFV-SOL002v030501p.pdf
  description: ETSI GS NFV-SOL 002 V3.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf

servers:
  - url: http://127.0.0.1/vnfconfig/v1
@@ -32,8 +32,8 @@ paths:

  /configuration:
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
    get:
      description: |
        The API consumer can use this method to read configuration information about a VNF instance and/or its VNFC instances.
+37 −4
Changes for src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml: 37 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -4,7 +4,30 @@
definitions:
  Alarm:
    description: >
      The alarm data type encapsulates information about an alarm.
      The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in 
      table 7.5.2.4-1.

      If the attribute "faultType" has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE", 
      the following provisions apply for the values of the attribute "faultDetails" related to 
      changes in the state of virtualised resources:
        - One of the entries in the array shall provide information about the anticipated time of maintenance in the
          following format: "anticipatedTime=$time", wherein "$time" shall be formatted as a "DateTime", as specified
          in ETSI GS NFV-SOL 013 [6].
        - One of the entries in the array shall provide identification information about the affinity/anti-affinity group
          defined in the VNFD that is associated to the affected virtualised resource indicated by "rootCauseFaultyResource" 
          in the following format: "affinityOrAntiAffinityGroupId=$group", wherein "$group" shall be equal to the 
          "affinityOrAntiAffinityGroupId" value in the corresponding "VduProfile" (for a VNFC/COMPUTE affected resource) 
          or "VirtualLinkProfile" for a VL/NETWORK affected resource) in the VNFD, which is mapped by the VNFM to the 
          virtualised resource group identifier in the virtualised resource change notification received by the VNFM from 
          the VIM.

      NOTE 1: For an alarm about upcoming impact due to NFVI operation and maintenance (i.e. the attribute "faultType" 
              has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE"), the attribute "rootCauseFaultyResource" 
              indicates a resource to be impacted. Further information on the upcoming impact (e.g. group of impacted 
              resources, time of impact) is provided in the attribute "faultDetails".
      NOTE 2: When alarms are due to upcoming NFVI operation and maintenance (i.e. the attribute "faultType" has the
              value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE"), the attribute "faultDetails" shall include information 
              about the anticipated time of the maintenance. See provisions under the present table.
    type: object
    required:
      - id
@@ -36,7 +59,8 @@ definitions:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      rootCauseFaultyResource:
        description: >
          The virtualised resources that are causing the VNF fault.
          The virtualised resources that are causing the VNF fault. Shall be present if the alarm affects 
          virtualised resources. See note 1.
        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo"
      alarmRaisedTime:
        description: >
@@ -75,7 +99,7 @@ definitions:
        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
      eventTime:
        description: >
          Time stamp indicating when the fault was observed.
          Time stamp indicating when the fault was observed. See note 2.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      eventType:
        description: >
@@ -85,10 +109,19 @@ definitions:
      faultType:
        description: >
          Additional information to clarify the type of the fault.
          If the alarm is related to changes in the state of virtualised resources due to NFVI 
          operation and maintenance, this attribute shall be set to "NFVI_OAM_VIRTUALISED_RESOURCE_STATE _CHANGE".
        type: string
      probableCause:
        description: >
          Information about the probable cause of the fault.
          If the attribute "faultType" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”, the 
          permitted values are: 
            - "NFVI_COMPONENT_MAINTENANCE": Maintenance of NFVI components, e.g. physical maintenance/repair, 
              hypervisor software updates, etc.
            - "NFVI_COMPONENT_EVACUATION": Evacuation of physical hosts.
            - "NFVI_COMPONENT_OPTIMIZATION": Operation and management of NFVI resources, e.g. to support energy
              efficiency or resource usage optimization.
        type: string
      isRootCause:
        description: >
@@ -104,7 +137,7 @@ definitions:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      faultDetails:
        description: >
          Provides additional information about the fault.
          Provides additional information about the fault. See notes 1 and 2.
        type: array
        items:
          type: string
+61 −29
Changes for src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml: 61 added lines, 29 removed lines.
Original line number Diff line number Diff line
@@ -16,11 +16,11 @@ info:
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  version: 1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 002 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.05.01_60/gs_NFV-SOL002v030501p.pdf
  description: ETSI GS NFV-SOL 002 V3.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf

servers:
  - url: http://127.0.0.1/vnffm/v1
@@ -32,16 +32,16 @@ paths:

  /alarms:
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
    get:
      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/SOL002_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
        - $ref: '#/components/parameters/filter_alarms'
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm
      responses:
        "200":
          $ref: '#/components/responses/Alarms.Get.200'
@@ -73,14 +73,14 @@ paths:
  /alarms/{alarmId}:
    parameters:
      - $ref: '#/components/parameters/AlarmId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
    get:
      description: |
        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
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
      responses:
        "200":
          $ref: '#/components/responses/IndividualAlarm.Get.200'
@@ -113,8 +113,8 @@ paths:
      description: |
        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
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/IndividualAlarmRequest'
      responses:
@@ -152,8 +152,8 @@ paths:
  /alarms/{alarmId}/escalate:
    parameters:
      - $ref: '#/components/parameters/AlarmId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
    post:
      description: |
        The POST method enables the API consumer to escalate the perceived severity of an alarm that is represented
@@ -190,17 +190,17 @@ paths:

  /subscriptions:
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
    get:
      description: |
        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
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
        - $ref: '#/components/parameters/filter_subscriptions'
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm
      responses:
        "200":
          $ref: '#/components/responses/Subscriptions.Get.200'
@@ -233,8 +233,8 @@ paths:
      description: |
        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
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/FmSubscriptionRequest'
      responses:
@@ -270,15 +270,15 @@ paths:
  /subscriptions/{subscriptionId}:
    parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002_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.6.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
      responses:
        "200":
          $ref: '#/components/responses/IndividualSubscription.Get.200'
@@ -340,6 +340,38 @@ paths:

components:
  parameters:
    filter_subscriptions:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        The VNFM shall support receiving this parameter as part of the URI query
        string. The EM may supply this parameter. The VNF may supply its instance
        Id as an attribute filter.
        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

    filter_alarms:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        The VNFM shall support receiving this parameter as part of the URI query string. The
        EM may supply this parameter. The VNF may supply its instance Id as an attribute
        filter.
        The following attribute names shall be supported in the filter expression: id,
        managedObjectId, vnfcInstanceIds, rootCauseFaultyResource.faultyResourceType,
        eventType, perceivedSeverity, probableCause. If the vnfcInstanceIds parameter is
        provided, exactly one value for the managedObjectId attribute shall be provided.
      in: query
      required: false
      schema:
        type: string

    AlarmId:
      name: alarmId
      in: path
Loading
Loading