Commit c2bcc532 authored by moscatelli's avatar moscatelli
Browse files

SOL005: fixes in VNF Pkg mgmt responses schema

parent 92dec060
Loading
Loading
Loading
Loading
+3 −3
Original line number Original line Diff line number Diff line
@@ -290,7 +290,7 @@ definitions:
      nsInstanceSubscriptionFilter:
      nsInstanceSubscriptionFilter:
        description: >
        description: >
          Filter criteria to select NS instances about which to notify.
          Filter criteria to select NS instances about which to notify.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NSInstanceSubscriptionFilter"
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
      notificationTypes:
      notificationTypes:
        description: >
        description: >
          Match particular notification types.
          Match particular notification types.
@@ -322,7 +322,7 @@ definitions:
          for the specified object instances. At least one
          for the specified object instances. At least one
          of the two attributes (performance metric or
          of the two attributes (performance metric or
          group) shall be present.
          group) shall be present.
        type: "array"
        type: array
        items:
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      performanceMetricGroup:
      performanceMetricGroup:
@@ -333,7 +333,7 @@ definitions:
          individual metrics. At least one of the two
          individual metrics. At least one of the two
          attributes (performance metric or group) shall
          attributes (performance metric or group) shall
          be present.
          be present.
        type: "array"
        type: array
        items:
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      collectionPeriod:
      collectionPeriod:
+1 −0
Original line number Original line Diff line number Diff line
# Copyright (c) ETSI 2017.
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
definitions:
  PerformanceInformationAvailableNotification:
  PerformanceInformationAvailableNotification:
    description: >
    description: >
+99 −140
Original line number Original line Diff line number Diff line
@@ -18,13 +18,13 @@ info:
externalDocs:
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.4.1
  description: ETSI GS NFV-SOL 005 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/vnfpkgm/v1"
basePath: /vnfpkgm/v1
schemes:
schemes:
  - https
  - https
consumes:
consumes:
  - "application/json"
  - application/json
produces:
produces:
  - "application/json"  
  - application/json
paths:
paths:
###############################################################################
###############################################################################
# VNF Packages                                                                #
# VNF Packages                                                                #
@@ -39,41 +39,41 @@ paths:
        Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
        Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
        request and response data structures, and response codes.
      parameters:
      parameters:
        - name: "filter"
        - name: filter
          in: "query"
          in: query
          required: false
          required: false
          type: "string"
          type: string
          description: >  
          description: >  
            Attribute-based filtering parameters according to clause 4.3.2.
            Attribute-based filtering parameters according to clause 4.3.2.
            The NFVO shall support receiving filtering parameters as part of the URI query string. The
            The NFVO shall support receiving filtering parameters as part of the URI query string. The
            OSS/BSS may supply filtering parameters.
            OSS/BSS may supply filtering parameters.
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
            be supported in attribute-based filtering parameters.
            be supported in attribute-based filtering parameters.
        - name: "all_fields"
        - name: all_fields
          in: "query"
          in: query
          required: false
          required: false
          type: "string"
          type: string
          description: >  
          description: >  
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
            shall support this parameter.
        - name: "fields"
        - name: fields
          in: "query"
          in: query
          required: false
          required: false
          type: "string"
          type: string
          description: >  
          description: >  
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
            NFVO should support this parameter.         
        - name: "exclude_fields"
        - name: exclude_fields
          in: "query"
          in: query
          required: false
          required: false
          type: "string"
          type: string
          description: >  
          description: >  
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
            NFVO should support this parameter.
        - name: "exclude_default"
        - name: exclude_default
          in: "query"
          in: query
          required: false
          required: false
          type: "string"
          type: string
          description: >  
          description: >  
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            for details.
@@ -112,7 +112,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:            
            WWW-Authenticate:            
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -170,19 +170,13 @@ paths:
        in: header
        in: header
        required: true
        required: true
        type: string
        type: string
      - name: "body"
      - name: body
        in: "body"
        in: body
        required: true
        required: true
        schema:
        schema:
          type: "object"
          required:
          - "CreateVnfPkgInfoRequest"
          properties:
            CreateVnfPkgInfoRequest:
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
        description: >
        description: >
          IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
          IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
            
      responses:
      responses:
        201:
        201:
          description: >  
          description: >  
@@ -196,12 +190,10 @@ paths:
            header that contains the resource URI of the individual
            header that contains the resource URI of the individual
            VNF package resource.
            VNF package resource.
          schema:
          schema:
            properties:
              VnfPkgInfo:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
          headers:
          headers:
            Content-Type:
            Content-Type:
              type: "string"
              type: string
              description: >
              description: >
                The MIME type of the body of the response.This header
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                field shall be present if the response has a non-empty message
@@ -209,24 +201,25 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1                
              minimum: 1                
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
                has provided an invalid authorization token.
              maximum: 1
              maximum: 1
              minimum: 0
              minimum: 0

  ###############################################################################
  ###############################################################################
  # Individual VNF Package                                                      #
  # Individual VNF Package                                                      #
  ###############################################################################
  ###############################################################################
  '/vnf_packages/{vnfPkgId}':
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
    parameters:
    parameters:
      - name: "vnfPkgId"
      - name: vnfPkgId
        description: >
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
        in: "path"
        in: path
        type: "string" 
        type: string
        required: true
        required: true
    get:
    get:
      summary: Read information about an individual VNF package.
      summary: Read information about an individual VNF package.
@@ -254,18 +247,15 @@ paths:
            
            
            Information of the VNF package.            
            Information of the VNF package.            
          schema:
          schema:
            type: "object"   
            properties:
              VnfPkgInfo:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
          headers:
          headers:
            Content-Type:
            Content-Type:
              type: "string"
              type: string
              description: >
              description: >
                The MIME type of the body of the response.This header
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
                field shall be present if the response has a non-empty message body.
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -290,6 +280,7 @@ paths:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

    delete:
    delete:
      summary: Delete an individual VNF package.
      summary: Delete an individual VNF package.
      description: >  
      description: >  
@@ -329,6 +320,7 @@ paths:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

    patch:
    patch:
      summary: Update information about an individual VNF package.
      summary: Update information about an individual VNF package.
      description: >  
      description: >  
@@ -338,15 +330,10 @@ paths:
        Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters,
        Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters,
        request and response data structures, and response codes."
        request and response data structures, and response codes."
      parameters:
      parameters:
      - name: "body"
      - name: body
        in: "body"
        in: body
        required: true
        required: true
        schema:
        schema:
          type: "object"
          required:
          - "VnfPkgInfoModifications"
          properties:
            VnfPkgInfoModifications:
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
        description: >
        description: >
          Parameters for VNF package information modifications.
          Parameters for VNF package information modifications.
@@ -380,7 +367,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -481,7 +468,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -515,12 +502,12 @@ paths:
  '/vnf_packages/{vnfPkgId}/package_content':
  '/vnf_packages/{vnfPkgId}/package_content':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
    parameters:
    parameters:
      - name: "vnfPkgId"
      - name: vnfPkgI
        description: >
        description: >
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
        in: "path"
        in: path
        required: true
        required: true
        type: "string"    
        type: string
    get:
    get:
      summary: Fetch an on-boarded VNF package.
      summary: Fetch an on-boarded VNF package.
      description: >  
      description: >  
@@ -543,10 +530,10 @@ paths:
        in: header
        in: header
        required: false
        required: false
        type: string
        type: string
      - name: "Range"
      - name: Range
        in: "header"
        in: header
        required: false
        required: false
        type: "string"
        type: string
        description: >  
        description: >  
          The request may contain a "Range" HTTP header to obtain single
          The request may contain a "Range" HTTP header to obtain single
          range of bytes from the VNF package file. This can be used to
          range of bytes from the VNF package file. This can be used to
@@ -572,7 +559,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -692,35 +679,20 @@ paths:
        in: header
        in: header
        required: false
        required: false
        type: string
        type: string
      - name: Content-Type
      - name: vnfPkgId
        description: >
          The MIME type of the body of the request.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string   
        
      - name: "vnfPkgId"
        description: >
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.
          Identifier of the VNF package. The identifier is allocated by the NFVO.
        in: "path"
        in: path
        required: true
        required: true
        type: "string"          
        type: string
        
      - name: body
      - name: "body"
        in: body
        in: "body"
        required: true
        required: true
        schema:
        schema:
          type: "object"
          required:
          - "UploadVnfPkgFromUriRequest"
          properties:
            UploadVnfPkgFromUriRequest:
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
        description: >
        description: >
          The payload body contains the address information based on
          The payload body contains the address information based on
          which the NFVO can obtain the content of the VNF package.
          which the NFVO can obtain the content of the VNF package.
          
      responses:
      responses:
        202:
        202:
          description: >
          description: >
@@ -821,14 +793,13 @@ paths:
             maximum: 1
             maximum: 1
             minimum: 1           
             minimum: 1           
           WWW-Authenticate:
           WWW-Authenticate:
             type: "string"
             type: string
             description: >
             description: >
               Challenge if the corresponding HTTP request has not provided
               Challenge if the corresponding HTTP request has not provided
               authorization, or error details if the corresponding HTTP request
               authorization, or error details if the corresponding HTTP request
               has provided an invalid authorization token.
               has provided an invalid authorization token.
             maximum: 1
             maximum: 1
             minimum: 0
             minimum: 0
               
       206:
       206:
         description: > 
         description: > 
           Partial Content.
           Partial Content.
@@ -852,7 +823,7 @@ paths:
             maximum: 1
             maximum: 1
             minimum: 1           
             minimum: 1           
           WWW-Authenticate:
           WWW-Authenticate:
             type: "string"
             type: string
             description: >
             description: >
               Challenge if the corresponding HTTP request has not provided
               Challenge if the corresponding HTTP request has not provided
               authorization, or error details if the corresponding HTTP request
               authorization, or error details if the corresponding HTTP request
@@ -880,7 +851,7 @@ paths:
       503:
       503:
         $ref: "../responses/SOL005_resp.yaml#/responses/503"
         $ref: "../responses/SOL005_resp.yaml#/responses/503"
         
         
##############################################################################
  ###############################################################################
  # Subscriptions                                                               #
  # Subscriptions                                                               #
  ###############################################################################
  ###############################################################################
  '/subscriptions':
  '/subscriptions':
@@ -919,21 +890,15 @@ paths:
        in: header
        in: header
        required: true
        required: true
        type: string
        type: string
      - name: "body"
      - name: body
        in: "body"
        in: body
        required: true
        required: true
        schema:
        schema:
          type: "object"
          required:
          - "PkgmSubscriptionRequest"
          properties:
            PkgmSubscriptionRequest:
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
          $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
        description: >
        description: >
          Representation of the created subscription resource.
          Representation of the created subscription resource.
          The HTTP response shall include a "Location" HTTP header that
          The HTTP response shall include a "Location" HTTP header that
          points to the created subscription resource.
          points to the created subscription resource.
            
      responses:
      responses:
        201:
        201:
          description: >
          description: >
@@ -949,7 +914,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -959,8 +924,6 @@ paths:
          schema:
          schema:
            type: array
            type: array
            items:
            items:
              properties:
                PkgmSubscription:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
        303:
        303:
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
@@ -991,10 +954,10 @@ paths:
        Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
        Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
        request and response data structures, and response codes.
      parameters:
      parameters:
        - name: "filter"
        - name: filter
          in: "query"
          in: query
          required: false
          required: false
          type: "string"
          type: string
          description: >  
          description: >  
            Attribute-based filtering parameters according to clause 4.3.2.
            Attribute-based filtering parameters according to clause 4.3.2.
            The NFVO shall support receiving filtering parameters as part of the URI query
            The NFVO shall support receiving filtering parameters as part of the URI query
@@ -1028,7 +991,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -1038,8 +1001,6 @@ paths:
          schema:
          schema:
            type: array
            type: array
            items:
            items:
              properties:
                PkgmSubscription:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
        400:
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
@@ -1109,7 +1070,7 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 1
              minimum: 1
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
@@ -1117,8 +1078,6 @@ paths:
              maximum: 1
              maximum: 1
              minimum: 0            
              minimum: 0            
          schema:
          schema:
            properties:
              PkgmSubscription:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
        400:
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
@@ -1158,7 +1117,7 @@ paths:
            The subscription resource was deleted successfully.
            The subscription resource was deleted successfully.
          headers:
          headers:
            WWW-Authenticate:
            WWW-Authenticate:
              type: "string"
              type: string
              description: >
              description: >
                Challenge if the corresponding HTTP request has not provided
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                authorization, or error details if the corresponding HTTP request
+0 −5
Original line number Original line Diff line number Diff line
swagger: "2.0"
swagger: "2.0"

info:
info:
  version: "1.1.0"
  version: "1.1.0"
  title: "SOL005 - VNF Package Management Notification interface"
  title: "SOL005 - VNF Package Management Notification interface"
@@ -23,17 +22,13 @@ info:
  license:
  license:
    name: "ETSI Forge copyright notice"
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.5.1
  description: ETSI GS NFV-SOL 005 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

basePath: /callback/v1
basePath: /callback/v1

schemes:
schemes:
  - http
  - http
  - https
  - https

consumes:
consumes:
  - application/json
  - application/json
produces:
produces:
+1 −0
Original line number Original line Diff line number Diff line
# Copyright (c) ETSI 2017.
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

responses:
responses:
  206:
  206:
    description: >
    description: >