Skip to content
Normal view History Permalink
VNFPackageManagement.yaml 54.2 KiB
Newer Older
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
1 
openapi: 3.0.2
Michele Carignani's avatar
Templates and folder structures for SOL005 APIs.
Michele Carignani committed
2 3 

info:
moscatelli's avatar
SOL005: OpenAPI version updated to 1.1.0 + broken references among files fixed  
moscatelli committed
4 
  title: SOL005 - VNF Package Management Interface
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
5 
  description: |
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
6 
    SOL005 - VNF Package Management Interface
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
7 8 
    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
Giacomo Bernini's avatar
updated link for reporting bugs  
Giacomo Bernini committed
9 
    takes precedence. Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
10 11 
  contact:
    name: NFV-SOL WG
Michele Carignani's avatar
Templates and folder structures for SOL005 APIs.
Michele Carignani committed
12 
  license:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
13 
    name: ETSI Forge copyright notice
Michele Carignani's avatar
Templates and folder structures for SOL005 APIs.
Michele Carignani committed
14 
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Giacomo Bernini's avatar
fixed issue #17  
Giacomo Bernini committed
15 
  version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:2
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
16
Michele Carignani's avatar
Templates and folder structures for SOL005 APIs.
Michele Carignani committed
17 
externalDocs:
piscione's avatar
SOL005_44: updated version of the document  
piscione committed
18 
  description: ETSI GS NFV-SOL 005 V3.5.1
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
19 
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf
Giacomo Bernini's avatar
fixed openapi info and externaldocs  
Giacomo Bernini committed
20
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
21 22 23 24 
servers:
  - url: http://127.0.0.1/vnfpkgm/v2
  - url: https://127.0.0.1/vnfpkgm/v2
Michele Carignani's avatar
Templates and folder structures for SOL005 APIs.
Michele Carignani committed
25 
paths:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
26 27 
  /api_versions:
    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
Samir Medjiah's avatar
SOL005: Consolidation of common data types, endpoint parameters, and responses...  
Samir Medjiah committed
28
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
29 
  /vnf_packages:
Samir Medjiah's avatar
SOL005: Consolidation of common data types, endpoint parameters, and responses...  
Samir Medjiah committed
30 
    parameters:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
31 32 
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
33 
    get:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
34 
      description: |
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
35 
        The GET method queries the information of the VNF packages matching the filter. See clause 9.4.2.3.2.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
36 
      parameters:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
37 38 39 40 41 42 43 
        - $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
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
44 
      responses:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 
        "200":
          $ref: '#/components/responses/VnfPackages.Get'
        "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
        "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
moscatelli's avatar
SOL005: fix in NS Lifecycle mgmt data types  
moscatelli committed
65
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
66 67 
    post:
      description: |
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
68 
        The POST method creates a new individual VNF package resource. See clause 9.4.2.3.1.
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
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 
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageCreationRequest'
      responses:
        "201":
          $ref: '#/components/responses/VnfPackages.Post'
        "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
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
99
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
100 
  /vnf_packages/{vnfPkgId}:
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
101 
    parameters:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
102 103 104 
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
105 
    get:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
106 
      description: |
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
107 
        The GET method reads the information of an individual VNF package. See clause 9.4.3.3.2.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
108 
      parameters:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
109 
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
110 
      responses:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Get'
        "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
        "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
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
131 132 

    delete:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
133 
      description: |
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
134 
        The DELETE method deletes an individual VNF Package resource. See clause 9.4.3.3.5.
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
135 
      responses:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 
        "204":
          $ref: '#/components/responses/IndividualVnfPackage.Delete'
        "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
        "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
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
158
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
159 160 
    patch:
      description: |
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
161 
        The PATCH method updates the information of a VNF package. See clause 9.4.3.3.4.
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
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 
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageModificationRequest'
      responses:
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Patch'
        "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
        "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
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
189
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
190 
  /vnf_packages/{vnfPkgId}/vnfd:
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
191 
    parameters:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
192 193 194 
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
195 
    get:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
196 
      description: |
Giacomo Bernini's avatar
updated endpoints descriptions  
Giacomo Bernini committed
197 
        The GET method reads the content of the VNFD within a VNF package. See clause 9.4.4.3.2.
Giacomo Bernini's avatar
SOL005 OpenAPI representations for v2.7.1  
Giacomo Bernini committed
198 
      parameters:
Francesca Moscatelli's avatar
VNF Pkg Management Interface migrated to OpenAPI 3.0.2  
Francesca Moscatelli committed
199 
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
Samir Medjiah's avatar
SOL005: fixing broken references  
Samir Medjiah committed
200 
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
Loading full blame...