Skip to content
Normal view History Permalink
VNFSnapshotPackageManagement.yaml 56.2 KiB
Newer Older
Samir Medjiah's avatar
SOL005_87: "VNF Snapshot Package Management" interface added
Samir Medjiah committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 
openapi: 3.0.2

info:
  title: SOL005 - VNF Snapshot Package Management interface
  description: |
    SOL005 - VNF Snapshot Package Management interface
    
    IMPORTANT: Please note that this file might be not aligned to the current
    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
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 005 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/xxx.pdf

servers:
  - url: http://127.0.0.1/vnfsnapshotpkgm/v1
  - url: https://127.0.0.1/vnfsnapshotpkgm/v1

paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  /api_versions:
    $ref: '../../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' 

  /vnf_snapshot_packages:
    parameters:
      - $ref: ../../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL005_params.yaml#/components/parameters/Accept
    post:
      description: |
        The POST method creates a new "Individual VNF snapshot package" resource.
      parameters:
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreateVnfSnapshotPkgInfoRequest'
      responses:
        201:
          $ref: '#/components/responses/VnfSnapshotPackages.Post.200'
        400:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        401:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        403:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        404:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        405:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        406:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        409:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
        416:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        500:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        503:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        504:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

    get:
      description: |
        The GET method queries the information of the VNF packages matching the filter.
      parameters:
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/VnfSnapshotPackages.Get.200'
        400:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/400
        401:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/401
        403:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/403
        404:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/404
        405:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/405
        406:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/406
        416:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/416
        422:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/422
        429:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/429
        500:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/500
        503:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/503
        504:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/504

  /vnf_snapshot_packages/{vnfSnapshotPkgId}:
    parameters:
      - $ref: ../../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: '#/components/parameters/VnfSnapshotPkgId'
    
    get:
      description: |
        The GET method reads the information of an individual VNF snapshot package.
      parameters:
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualVNFSnapshotPackage.Get.200'
        400:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/400
        401:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/401
        403:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/403
        404:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/404
        405:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/405
        406:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/406
        416:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/416
        422:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/422
        429:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/429
        500:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/500
        503:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/503
        504:
          $ref: ../../responses/SOL005_resp.yaml#/components/responses/504

    patch:
      description: |
        The PATCH method updates the information of a VNF snapshot package.
      parameters:
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/ContentType
        - $ref: ../../components/SOL005_params.yaml#/components/parameters/Accept
      requestBody:
        $ref: '#/components/requestBodies/VnfSnapshotPkgInfoModifications'
      responses:
        200:
          $ref: '#/components/responses/IndividualVNFSnapshotPackage.Patch.200'
        400:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        401:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        403:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        404:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        405:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        406:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        409:
          # description: |
          #   409 CONFLICT 
          
          #   Shall be returned upon the following error: The operation cannot be executed
          #   currently, due to a conflict with the state of the resource.

          #   Typically, this is due to the fact that the state of the VNF snapshot package
          #   resource is in a state other than CREATED, ERROR_EXTRACTING or AVAILABLE.

          #   The response body shall contain a ProblemDetails structure, in which the "detail" 
          #   attribute shall convey more information about the error.
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
        416:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        500:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        503:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        504:
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

    delete:
      description: |
        The DELETE method deletes an "Individual VNF snapshot package" resource.
      responses:
        204:
          $ref: '#/components/responses/IndividualVNFSnapshotPackage.Delete.204'
        400:
Loading full blame...