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

info:
4
  version: "1.2.0"
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.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.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
51
52
53
54
###############################################################################
# Resource: Grants                                                            #
###############################################################################
  '/grants':
  #SOL003 location: 9.4.2
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
55
56
57
        Grant Lifecycle Operation


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
        The POST method requests a grant for a particular VNF lifecycle
        operation.
      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
85
          required: false
86
          type: string
87
88
89
90
91
92
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
93
94
95
      responses:
        201:
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
96
97
            Created

98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
            The grant was 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.
          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
113
114
115
116
117
118
119
120
            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
121
122
123
124
125
126
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
127
128
129
130
          schema:
            $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant"
        202:
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
131
132
            Accepted

133
134
135
136
137
138
139
140
141
142
143
144
            The request was accepted for processing, but the processing has
            not been completed. It is expected to take some time to create
            the grant (asynchronous mode).
            The response body shall be empty.
            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.
          headers:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
145
146
147
148
149
150
151
152
            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
153
154
155
156
157
158
        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
159
160
            Forbidden

161
162
163
164
165
            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:
166
167
            Content-Type:
              description: The MIME type of the body of the response.
168
169
              type: string
              maximum: 1
170
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
171
172
173
174
175
176
177
178
            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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
          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"
###############################################################################
# Resource: Individual grant                                                  #
###############################################################################
  '/grants/{grantId}':
  #SOL003 location: 9.4.3
    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
213
214
215
        Grant Lifecycle Operation

        
216
217
        The GET method retrieves information about a specific grant by reading
        an individual grant resource.
Gergely Csatari's avatar
Gergely Csatari committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
      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
233
234
235
236
237
238
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
239
240
241
      responses:
        200:
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
242
243
            OK

244
245
246
247
248
249
250
251
252
            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
253
254
255
256
257
258
259
260
            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
261
262
263
264
265
266
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
267
268
269
270
          schema:
            $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant"
        202:
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
271
272
            Accepted

273
274
275
            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
276
277
278
279
280
281
282
283
284
          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
285
286
287
288
289
290
        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
291
292
            Forbidden

293
294
295
296
297
            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:
298
299
            Content-Type:
              description: The MIME type of the body of the response.
300
301
              type: string
              maximum: 1
302
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
303
304
305
306
307
308
309
310
            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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
          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"