Commit 1e7f3d52 authored by Michele Carignani's avatar Michele Carignani
Browse files

Aligned SOL 002 interfaces with look and feel of SOL003, 


fixed errors in the headers:
- Bug 40
- Bug 25
- Bug 35

Patch set 2 reinstates the labels or status code

Change-Id: I28fc57587f828f3b3ed05d6e7a6dc77639a36abe
Signed-off-by: default avatarMichele Carignani <michele.carignani@etsi.org>
parent 90a35965

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+5 −2
Original line number Diff line number Diff line
@@ -34,8 +34,11 @@ produces: 




paths:



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

# Configuration                                                               #

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

    /configuration:

      #SOL002 location: 9.4.2

      get:

        summary: Read VNF/VNFC configuration from VNF.

        description: >

src/SOL002/VNFConfiguration/definitions/VnfConfiguration_def.yaml

+5 −3
Original line number Diff line number Diff line
@@ -93,9 +93,11 @@ definitions: 
        description: >

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

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

      extCpConfig:

      intCpConfig:

        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'                  

      dhcpServer:

        description: >

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+52 −17
Original line number Diff line number Diff line
@@ -2,10 +2,9 @@ swagger: "2.0" 


info: 

  version: "1.1.1"

  title: SOL002 - VNF Configuration interface

  title: DRAFT - SOL002 - VNF Fault Management interface

  description: >

    VNF Configuration interface of ETSI NFV SOL002



    DRAFT VNF Fault Management interface of ETSI NFV SOL002



    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
@@ -22,7 +21,7 @@ externalDocs: 
  description: ETSI GS NFV-SOL 002 V2.4.1

  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf



basePath: /vnfconfig/v1

basePath: /vnffm/v1



schemes: 

  - http
@@ -40,7 +39,7 @@ paths: 
# Alarms                                                                      #

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

  '/alarms':

  #SOL003 location: 7.4.2

  #SOL002 location: 7.4.2

    get:

      description: >

        The client can use this method to retrieve information about the alarm
@@ -70,8 +69,6 @@ paths: 
      responses:

        200:

          description: > 

            OK



            The request has succeeded.

            The response body shall contain the list of related alarms.

          headers:
@@ -110,7 +107,7 @@ paths: 
# Individual alarm                                                            #

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

  '/alarms/{alarmId}':

  #SOL003 location: 7.4.3

  #SOL002 location: 7.4.3

    parameters:

      - name: alarmId

        description: >
@@ -151,8 +148,6 @@ paths: 
      responses:

        200:

          description: > 

            OK



            Information about an individual alarm was read successfully.

            The response body shall contain a representation of the individual

            alarm.
@@ -193,7 +188,7 @@ paths: 
        This method modifies an individual alarm resource.

      parameters:

        - name: AlarmModifications

          description: The VNF creation parameters

          description: The parameter for the alarm modification

          in: body

          required: true

          schema:
@@ -207,8 +202,8 @@ paths: 
          type: string

        - name: Content-Type

          description: >

            The MIME type of the body of the request.

            Reference: IETF RFC 7231

            The Content-Type header shall be set to "application/mergepatch+json"

            Reference: IETF RFC 7396

          in: header

          required: true

          type: string
@@ -264,10 +259,48 @@ paths: 
        503:

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

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

# Escalate Perceived Severity task                                                               #

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

  '/alarms/{alarmId}/escalate':

  #SOL002 location: 7.4.4  

    post:

      description: >

        The POST method enables the consumer to escalate the perceived severity 

        of an alarm that is represented by an ndividual alarm resource. 

      parameters:

       - name: PerceivedSeverityRequest

         description: The proposed "escalated perceived severity" value

         in: body

         schema:

          $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest"

      responses:

        200:

          description: >

            OK



            The VNFM has received the proposed "escalated perceived severity" value 

            successfully. The response body shall be empty.

        400:

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

        401:

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

        403:

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

        405:

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

        406:

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

        412:

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

        500:

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

        503:

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

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

# Subscriptions                                                               #

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

  '/alarms/subscriptions':

  #SOL003 location: 7.4.4

  #SOL002 location: 7.4.5

    post:

      description: >

        The POST method creates a new subscription.
@@ -331,6 +364,8 @@ paths: 
              minimum: 0

          schema:

            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"

        303:

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

        400:

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

        401:
@@ -418,7 +453,7 @@ paths: 
# Individual subscription                                                     #

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

  '/subscriptions/{subscriptionId}':

  #SOL003 location: 7.4.5

  #SOL002 location: 7.4.5

    parameters:

      - name: subscriptionId

        description: >

src/SOL002/VNFFaultManagement/definitions/VNFFaultManagement_def.yaml

+3 −1
Original line number Diff line number Diff line
@@ -114,3 +114,5 @@ definitions: 
            #  notified alarm is correlated. Shall be present if the VNF

            #  instance information is accessible as a resource.

            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  PerceivedSeverityRequest:

    type: string
 
 No newline at end of file

src/SOL002/VNFIndicator/VNFIndicator.yaml

+9 −6
Original line number Diff line number Diff line
@@ -3,9 +3,9 @@ swagger: "2.0" 


info: 

  version: "1.1.1"

  title: "SOL002 - VNF Indicator interface"

  title: DRAFT - SOL002 - VNF Indicator interface

  description: >

    VNF Indicator interface of ETSI NFV SOL002.

    DRAFT VNF Indicator interface of ETSI NFV SOL002.

    

    This API allows the EM/VNF to provide information on value changes of VNF related indicators. 

    VNF related indicators are declared in the VNFD.
@@ -40,11 +40,13 @@ produces: 




paths:



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

# VNF Indicators                                                              #

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

    /indicators:

      get:

        summary: Query multiple indicators

        description: Get a list of indicators. Support of attribute based filtering via query parameters.

        description: The GET method queries multiple VNF indicators. 

#        parameters:

#         - name: id.eq

#           in: query
@@ -237,9 +239,10 @@ paths: 
         type: string

         required: true

      get:

        summary: Read an inidividual VNF indicator related to a VNF instance.

        summary: Read an inidividual VNF indicator.

        description: >

          Read an individual VNF indicator related to a specific VNF instance.

          The GET method reads an individual VNF indicator.

          

          NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a 

          POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body 

          of that response.