Commit db18c9c3 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Merge branch '3.6.1-dev'

parents 25626973 5cba6a9a

Readme.md

+1 −1
Original line number Diff line number Diff line 
# NFV SOL002 and SOL003 APIs



This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation

for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.5.1.

for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.6.1.



The APIs described in this repository are defined for the following reference points:

docker/Dockerfile

+1 −1
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

src/SOL002/APIVersion/APIVersion.yaml

+2 −2
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:

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+4 −4
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.

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+61 −29
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