Commit 83a38bf1 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Merge branch '2.8.1-dev' into '2.8.1' 

SOL002 and SOL003 OpenAPI representations for v2.8.1

See merge request nfv/SOL002-SOL003!16
parents e3eec91b 2325aca6

Readme.md

+2 −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](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_NFV-SOL002v020701p.pdf) and [SOL003](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_nfv-sol003v020701p.pdf).

for the APIs defined in ETSI NFV GSs [SOL002](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf) and 

[SOL003](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_nfv-sol003v020801p.pdf).



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

src/SOL002/APIVersion/APIVersion.yaml

+3 −3
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/SOL002-SOL003/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 002 V2.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf

  description: ETSI GS NFV-SOL 002 V2.8.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf



schemes:

  - http

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+4 −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/SOL002-SOL003/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 002 V2.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf

  description: ETSI GS NFV-SOL 002 V2.8.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf



basePath: /vnfconfig/v1
@@ -58,9 +58,8 @@ paths: 
        required: false

        type: string

    get:

      summary: Read VNF/VNFC configuration from VNF

      description: >

        The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.

        The API consumer can use this method to read configuration information about a VNF instance and/or its VNFC instances.

      responses:

        200:

          description: >
@@ -113,7 +112,6 @@ paths: 
        504:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

    patch:

      summary: Modify VNF/VNFC configuration.

      description: This method sets or modifies a configuration resource.

      parameters:

        - name: configModifications

src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml

+1 −0
Original line number Diff line number Diff line
@@ -100,6 +100,7 @@ definitions: 
      vnfcInstanceId:

        description: >

          Identifier of a VNFC instance to which this set of configuration data applies.

          The identifier references the "id" attribute in a "VnfcInfo" structure.

        $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'

      intCpConfig:

        description: >

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+13 −13
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/SOL002-SOL003/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 002 V2.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf

  description: ETSI GS NFV-SOL 002 V2.8.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf



basePath: /vnffm/v1
@@ -43,7 +43,7 @@ paths: 
  # Alarms                                                                      #

  ###############################################################################

  '/alarms':

    #SOL003 location: 7.4.2

    #SOL002 location: 7.4.2

    parameters:

      - name: Version

        description: >
@@ -60,7 +60,7 @@ paths: 
        type: string

    get:

      description: >

        The client can use this method to retrieve information about the alarm

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

        list.

      parameters:

        - name: Accept
@@ -190,7 +190,7 @@ paths: 
  # Individual alarm                                                            #

  ###############################################################################

  '/alarms/{alarmId}':

    #SOL003 location: 7.4.3

    #SOL002 location: 7.4.3

    parameters:

      - name: alarmId

        description: >
@@ -218,7 +218,7 @@ paths: 
        type: string

    get:

      description: >

        The client can use this method to read an individual alarm.

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

      parameters:

        - name: Accept

          description: >
@@ -474,7 +474,7 @@ paths: 
  # Subscriptions                                                               #

  ###############################################################################

  '/subscriptions':

    #SOL003 location: 7.4.4

    #SOL002 location: 7.4.5

    parameters:

      - name: Version

        description: >
@@ -602,8 +602,8 @@ paths: 
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

    get:

      description: >

        The client can use this method to retrieve the list of active

        subscriptions for VNF alarms subscribed by the client. It can be used

        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.

      parameters:

        - name: Accept
@@ -667,7 +667,7 @@ paths: 
          description: >

            200 OK



            The list of subscriptions has been queried successfully. The response

            Shall be returned when the list of subscriptions has been queried successfully. The response

            body shall contain the representations of all active

            subscriptions of the functional block that invokes the method.

            If the "filter" URI parameter was supplied in the request, the data
@@ -759,8 +759,8 @@ paths: 
        type: string

    get:

      description: >

        The client can use this method for reading an individual subscription

        for VNF alarms subscribed by the client.

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

        for VNF alarms subscribed by the API consumer.

      parameters:

        - name: Accept

          description: >