VNFLifecycleOperationGranting.yaml 11.9 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL003 - VNF Lifecycle Operation Granting interface
6
  description: >
7
8
    SOL003 - VNF Lifecycle Operation Granting interface

9

10
    IMPORTANT: Please note that this file might be not aligned to the current
11
12
13
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

14

15
16
17
18
19
20
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
21

22
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
23
24
25
26
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

27
externalDocs:
28
29
  description: ETSI GS NFV-SOL 003 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
30

31
32
33
34
35
36
37
38
39
40
41
basePath: "/grant/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
42
43
44
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
45
  '/api-versions':
46
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
47

48
49
50
  ###############################################################################
  # Resource: Grants                                                            #
  ###############################################################################
51
  '/grants':
52
    #SOL003 location: 9.4.2
53
54
    post:
      description: >
55
56
57
58
59
60
61
62
63
        Grant Lifecycle Operation.
        The POST method requests a grant for a particular VNF lifecycle operation.
        This method shall follow the provisions specified in the tables 9.4.2.3.1-1 and 9.4.2.3.1-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully processing this request, a new "Individual grant" resource
        shall be created. In the synchronous case which is indicated by responding with "201 Created",
        that resource shall be created before the 200 OK response is returned. In the asynchronous
        case which is indicated by responding with "202 Accepted", this resource may be created
        after the response is returned.
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
      parameters:
        - name: GrantRequest
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/GrantRequest"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
89
          required: false
90
          type: string
91
92
93
94
95
96
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
97
98
99
      responses:
        201:
          description: >
100
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
101

102
103
104
105
            Shall be returned when the grant has been created successfully (synchronous mode).
            A representation of the created "Individual grant" resource shall be returned in the response body.
            The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual grant"
            resource just created.
106
107
108
109
110
111
112
113
114
115
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
116
117
118
119
120
121
122
123
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
124
125
126
127
128
129
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
130
131
132
133
          schema:
            $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant"
        202:
          description: >
134
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
135

136
137
            Shall be returned when the request has been accepted for processing
            and it is expected to take some time to create the grant (asynchronous mode).
138
            The response body shall be empty.
139
140
            The HTTP response shall include a "Location" HTTP header that indicates the URI
            of the "Individual grant" resource that will be created once the granting decision has been made.
141
142
143
144
145
          headers:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
146
147
148
149
150
151
152
153
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
154
155
156
157
158
159
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          description: >
160
            403 FORBIDDEN
Gergely Csatari's avatar
Gergely Csatari committed
161

162
163
            Shall be returned upon the following error: The grant has been rejected.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
164
165
166
167
168
169
170
171
172
173
174
175
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
176
177
178
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

179
180
181
  ###############################################################################
  # Resource: Individual grant                                                  #
  ###############################################################################
182
  '/grants/{grantId}':
183
    #SOL003 location: 9.4.3
184
185
186
187
188
189
190
191
192
193
194
195
196
    parameters:
      - name: grantId
        description: >
          Identifier of the grant.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request granting a
          new VNF lifecycle operation. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
197
198
        Grant Lifecycle Operation

199

200
201
        The GET method retrieves information about a specific grant by reading
        an individual grant resource.
Gergely Csatari's avatar
Gergely Csatari committed
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
217
218
219
220
221
222
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
223
224
225
      responses:
        200:
          description: >
226
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
227

228
229
230
231
232
233
234
235
236
            The grant was read successfully.
            A representation of the "individual grant" resource shall be
            returned in the response body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
237
238
239
240
241
242
243
244
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
245
246
247
248
249
250
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
251
252
253
254
          schema:
            $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant"
        202:
          description: >
255
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
256

257
258
259
            The process of creating the grant is ongoing, no grant is
            available yet.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
260
261
262
263
264
265
266
267
268
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
269
270
271
272
273
274
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
275
276
            Forbidden

277
278
279
280
281
            The grant was rejected.
            A ProblemDetails structure shall be included in the response to
            provide more details about the rejection in the "details"
            attribute.
          headers:
282
283
            Content-Type:
              description: The MIME type of the body of the response.
284
285
              type: string
              maximum: 1
286
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
287
288
289
290
291
292
293
294
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
          schema:
            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"