Commit 691a9cb7 authored by Giacomo Bernini's avatar Giacomo Bernini Committed by admin_forge
Browse files

SOL003_053: ExtLinkPortData removed from VNF Lifecycle Management def (already...

SOL003_053: ExtLinkPortData removed from VNF Lifecycle Management def (already present in common generic def)
parent 5b48a59a
Loading
Loading
Loading
Loading
+1 −1
Original line number Original line Diff line number Diff line
# NFV SOL002 and SOL003 APIs
# NFV SOL002 and SOL003 APIs


This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
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.06.01_60/gs_NFV-SOL002v020601p.pdf) and [SOL003](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf).
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).


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


+8 −8
Original line number Original line Diff line number Diff line
swagger: "2.0"
swagger: "2.0"


info:
info:
  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL002 - API version interface
  title: SOL002 - API version interface
  description: >
  description: >
    SOL002 - API version Interface
    SOL002 - API version Interface
@@ -17,8 +17,8 @@ info:
    name: NFV-SOL WG
    name: NFV-SOL WG


externalDocs:
externalDocs:
  description: ETSI GS NFV-SOL 002 V2.5.1
  description: ETSI GS NFV-SOL 002 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf


schemes:
schemes:
  - http
  - http
@@ -34,17 +34,17 @@ paths:
  ###############################################################################
  ###############################################################################
  # API Versions                                                                #
  # API Versions                                                                #
  ###############################################################################
  ###############################################################################
  '/vnfconfig/api-versions':
  '/vnfconfig/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'


  '/vnffm/api-versions':
  '/vnffm/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'


  '/vnfind/api-versions':
  '/vnfind/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'


  '/vnflcm/api-versions':
  '/vnflcm/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'


  '/vnfpm/api-versions':
  '/vnfpm/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
 No newline at end of file
+12 −14
Original line number Original line Diff line number Diff line
@@ -17,8 +17,8 @@ info:
    name: NFV-SOL WG
    name: NFV-SOL WG


externalDocs:
externalDocs:
  description: ETSI GS NFV-SOL 002 V2.6.1
  description: ETSI GS NFV-SOL 002 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf


basePath: /vnfconfig/v1
basePath: /vnfconfig/v1


@@ -36,7 +36,7 @@ paths:
  ###############################################################################
  ###############################################################################
  # API Versions                                                                #
  # API Versions                                                                #
  ###############################################################################
  ###############################################################################
  '/api-versions':
  '/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'


  ###############################################################################
  ###############################################################################
@@ -102,8 +102,6 @@ paths:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
        429:
@@ -160,16 +158,16 @@ paths:
        406:
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        412:
        412:
          description: >
          # description: >
            412 PRECONDITION FAILED
          #   412 PRECONDITION FAILED

            Shall be returned upon the following error: A precondition given 
            in an HTTP request header is not fulfilled.
            Typically, this is due to an ETag mismatch, indicating that the resource 
            was modified by another entity. The response body should contain a 
            ProblemDetails structure, in which the "detail" attribute should convey 
            more information about the error.


          #   Shall be returned upon the following error: A precondition given 
          #   in an HTTP request header is not fulfilled.
          #   Typically, this is due to an ETag mismatch, indicating that the resource 
          #   was modified by another entity. The response body should contain a 
          #   ProblemDetails structure, in which the "detail" attribute should convey 
          #   more information about the error.
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        416:
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
+8 −4
Original line number Original line Diff line number Diff line
@@ -76,6 +76,8 @@ definitions:
      extCpConfig:
      extCpConfig:
        description: >
        description: >
          Configuration parameters for the external CPs of the VNF instance.
          Configuration parameters for the external CPs of the VNF instance.
        type: array
        items:
          $ref: '#/definitions/CpConfiguration'
          $ref: '#/definitions/CpConfiguration'
      dhcpServer:
      dhcpServer:
        description: >
        description: >
@@ -99,9 +101,11 @@ definitions:
        description: >
        description: >
          Identifier of a VNFC instance to which this set of configuration data applies.
          Identifier of a VNFC instance to which this set of configuration data applies.
        $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
        $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
      extCpConfig:
      intCpConfig:
        description: >
        description: >
          Configuration parameters for the external CPs of the VNFC instance.
          Configuration parameters for the internal CPs of the VNFC instance.
        type: array
        items:
          $ref: '#/definitions/CpConfiguration'
          $ref: '#/definitions/CpConfiguration'
      dhcpServer:
      dhcpServer:
        description: >
        description: >
+52 −36
Original line number Original line Diff line number Diff line
swagger: "2.0"
swagger: "2.0"


info:
info:
  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL002 - VNF Fault Management interface
  title: SOL002 - VNF Fault Management interface
  description: >
  description: >
    SOL002 - VNF Fault Management interface
    SOL002 - VNF Fault Management interface
@@ -17,8 +17,8 @@ info:
    name: NFV-SOL WG
    name: NFV-SOL WG


externalDocs:
externalDocs:
  description: ETSI GS NFV-SOL 002 V2.6.1
  description: ETSI GS NFV-SOL 002 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf


basePath: /vnffm/v1
basePath: /vnffm/v1


@@ -36,7 +36,7 @@ paths:
  ###############################################################################
  ###############################################################################
  # API Versions                                                                #
  # API Versions                                                                #
  ###############################################################################
  ###############################################################################
  '/api-versions':
  '/api_versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'


  ###############################################################################
  ###############################################################################
@@ -186,7 +186,6 @@ paths:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  ###############################################################################
  # Individual alarm                                                            #
  # Individual alarm                                                            #
  ###############################################################################
  ###############################################################################
@@ -355,27 +354,29 @@ paths:
        406:
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
        409:
          description: >
          # description: >
            409 CONFLICT
          #   409 CONFLICT


            Shall be returned upon the following error: The operation cannot be executed 
          #   Shall be returned upon the following error: The operation cannot be executed 
            currently, due to a conflict with the state of the "Individual alarm" resource.
          #   currently, due to a conflict with the state of the "Individual alarm" resource.
            Typically, this is due to the fact that the alarm is already in the state that 
          #   Typically, this is due to the fact that the alarm is already in the state that 
            is requested to be set (such as trying to acknowledge an already-acknowledged 
          #   is requested to be set (such as trying to acknowledge an already-acknowledged 
            alarm).
          #   alarm).
            The response body shall contain a ProblemDetails structure, in which the 
          #   The response body shall contain a ProblemDetails structure, in which the 
            "detail" attribute shall convey more information about the error.
          #   "detail" attribute shall convey more information about the error.
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        412:
        412:
          description: >
          # description: >
            412 PRECONDITION FAILED
          #   412 PRECONDITION FAILED


            ErrorShall be returned upon the following error: A precondition given in an 
          #   ErrorShall be returned upon the following error: A precondition given in an 
            HTTP request header is not fulfilled.
          #   HTTP request header is not fulfilled.
            Typically, this is due to an ETag mismatch, indicating that the resource was 
          #   Typically, this is due to an ETag mismatch, indicating that the resource was 
            modified by another entity. 
          #   modified by another entity. 
            The response body should contain a ProblemDetails structure, in which the 
          #   The response body should contain a ProblemDetails structure, in which the 
            "detail" attribute should convey more information about the error.
          #   "detail" attribute should convey more information about the error.
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        416:
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
@@ -389,7 +390,6 @@ paths:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  ###############################################################################
  # Escalate Perceived Severity task                                            #
  # Escalate Perceived Severity task                                            #
  ###############################################################################
  ###############################################################################
@@ -436,7 +436,7 @@ paths:
      responses:
      responses:
        200:
        200:
          description: >
          description: >
            200 OK
            204 No Content


            Shall be returned when the VNFM has received the proposed "escalated 
            Shall be returned when the VNFM has received the proposed "escalated 
            perceived severity" value successfully. The response body shall be empty.
            perceived severity" value successfully. The response body shall be empty.
@@ -470,7 +470,6 @@ paths:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  ###############################################################################
  # Subscriptions                                                               #
  # Subscriptions                                                               #
  ###############################################################################
  ###############################################################################
@@ -550,14 +549,15 @@ paths:
          schema:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        303:
        303:
          description: >
          # description: >
            303 SEE OTHER
          #   303 SEE OTHER


            A subscription with the same callbackURI and the same filter already exists and the policy of
          #   A subscription with the same callbackURI and the same filter already exists and the policy of
            the VNFM is to not create redundant subscriptions.
          #   the VNFM is to not create redundant subscriptions.
            The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
          #   The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
            existing subscription resource.
          #   existing subscription resource.
            The response body shall be empty.
          #   The response body shall be empty.
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
        400:
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
@@ -574,6 +574,23 @@ paths:
        416:
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
        422:
          # description: >
          #   422 UNPROCESSABLE ENTITY

          #   Shall be returned upon the following error: The content
          #   type of the payload body is supported and the payload
          #   body of a request contains syntactically correct data but
          #   the data cannot be processed.
          #   The general cause for this error and its handling is
          #   specified in clause 6.4 of ETSI GS NFV-SOL 013 [6],
          #   including rules for the presence of the response body.
          #   Specifically in case of this resource, the response code
          #   422 shall also be returned if the VNFM has tested the
          #   Notification endpoint as described in clause 7.4.7.3.2
          #   and the test has failed.
          #   In this case, the "detail" attribute in the "ProblemDetails"
          #   structure shall convey more information about the error
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
@@ -711,7 +728,6 @@ paths:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  ###############################################################################
  # Individual subscription                                                     #
  # Individual subscription                                                     #
  ###############################################################################
  ###############################################################################
Loading