SOL002SOL003_resp.yaml 17 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
responses:
  202:
    description: >
      The request was accepted for processing, but processing has not
      been completed. The response shall have an empty payload body.
    headers:
      #TODO: Add headers defined in 4.3.4.3
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
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
        maximum: 1
        minimum: 1
      Location:
        description: The resource URI of the created VNF instance
        type: string
        format: url
      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
  202-with-Location:
    description: > 
      The request was accepted for processing, but the processing has not
      been completed. On success, the HTTP response shall include a
      "Location" HTTP header that contains the URI of the newly-created
      "VNF LCM operation occurrence" resource corresponding to the
      operation.
    headers:
      #TODO: Add headers defined in 4.3.4.3
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
37
38
39
40
41
42
43
44
45
46
47
48
49
50
        maximum: 1
        minimum: 1
      Location:
        description: The resource URI of the created VNF instance
        type: string
        format: url
      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
51
52
53
54
55
56
57
58
  303:
    description: >
      A subscription with the same callbackURI and the same filter already
      exists and the policy of the VNFM is to not create redundant
      subscriptions.
      The HTTP response shall include a "Location" HTTP header that contains
      the resource URI of the existing subscription resource.
      The response body shall be empty.
59
60
61
62
63
64
65
66
67
68
69
  400:
    description: >
      It fhe request is malformed or syntactically incorrect (e.g. if the
      request URI contains incorrect query parameters or a syntactically
      incorrect payload body), the API producer shall respond with this
      response code. The "ProblemDetails" structure shall be provided,
      and should include in the "detail" attribute more information about
      the source of the problem.
      If the request contains a malformed access token, the API producer
      should respond with this response. The details of the error shall
      be returned in the WWW-Authenticate HTTP header, as defined in
70
71
      IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be
      provided.
72
      If there is an application error related to the client's input that
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
      cannot be easily mapped to any other HTTP response code ("catch all
      error"), the API producer shall respond with this response code.The
      "ProblemDetails" structure shall be provided, and shall include in
      the "detail" attribute more information about the source of the
      problem.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      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
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  400-attr-based-filtering-error:
    description: >
      Invalid attribute-based filtering parameters or Invalid attribute
      selector.
      It fhe request is malformed or syntactically incorrect (e.g. if the
      request URI contains incorrect query parameters or a syntactically
      incorrect payload body), the API producer shall respond with this
      response code. The "ProblemDetails" structure shall be provided,
      and should include in the "detail" attribute more information about
      the source of the problem.
      If the request contains a malformed access token, the API producer
      should respond with this response. The details of the error shall
      be returned in the WWW-Authenticate HTTP header, as defined in
107
108
      IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be
      provided.
109
      If there is an application error related to the client's input that
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
      cannot be easily mapped to any other HTTP response code ("catch all
      error"), the API producer shall respond with this response code.The
      "ProblemDetails" structure shall be provided, and shall include in
      the "detail" attribute more information about the source of the
      problem.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      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
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  400-attr-selector:
    description: >
      It fhe request is malformed or syntactically incorrect (e.g. if the
      request URI contains incorrect query parameters or a syntactically
      incorrect payload body), the API producer shall respond with this
      response code. The "ProblemDetails" structure shall be provided,
      and should include in the "detail" attribute more information about
      the source of the problem.
      If the request contains a malformed access token, the API producer
      should respond with this response. The details of the error shall
      be returned in the WWW-Authenticate HTTP header, as defined in
140
141
      IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be
      provided.
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
      If there is an application error related to the client's input that
      cannot be easily mapped to any other HTTP response code ("catch all
      error"), the API producer shall respond with this response code.The
      "ProblemDetails" structure shall be provided, and shall include in
      the "detail" attribute more information about the source of the
      problem.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      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
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  401:
    description: >
      If the request contains no access token even though one is
      required, or if the request contains an authorization token that
      is invalid (e.g. expired or revoked), the API producer should
      respond with this response. The details of the error shall be
      returned in the WWW-Authenticate HTTP header, as defined in
171
      IETF RFC 6750 and IETF RFC 7235. The ProblemDetails
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
      structure may be provided.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      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
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  403:
    description: >
      If the API consumer is not allowed to perform a particular request
      to a particular resource, the API producer shall respond with this
      response code. The "ProblemDetails" structure shall be provided. 
      It should include in the "detail" attribute information about the
      source of the problem, and may indicate how to solve it.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  404:
    description: >
      If the API producer did not find a current representation for the
      resource addressed by the URI passed in the request, or is not
      willing to disclose that one exists, it shall respond with this
      response code. 
      The "ProblemDetails" structure may be provided,
      including in the "detail" attribute information about the source
      of the problem, e.g. a wrong resource URI variable.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  404-task-resource-not-exists:
    description: >
      Error: The API producer did not find a current representation for the
      target resource or is not willing to disclose that one exists.
      Specifically in case of this task resource, the  response code 404 shall
      also returned if the task is not supported for the VNF instance
      represented by the parent resource, which means that the task resource
      consequently does not exist. 
      In this case, the response body shall be present, and shall contain a
      ProblemDetails structure, in which the "detail" attribute shall convey
      more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
235
236
        type: string
        maximum: 1
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  404-task-resource-not-exists-VNF-LCM:
    description: >
      Error: The API producer did not find a current representation for the
      target resource or is not willing to disclose that one exists.
      Specifically in case of this task resource, the  response code 404 shall
      also be returned if the task is not supported for the VNF LCM operation
      occurrence represented by the parent resource, which means that the task
      resource consequently does not exist. 
      In this case, the response body shall be present, and shall contain a
      ProblemDetails structure, in which the "detail" attribute shall convey
      more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  404-task-not-suported:
    description: >
      If the API producer did not find a current representation for the
      resource addressed by the URI passed in the request, or is not
      willing to disclose that one exists, it shall respond with this
      response code. 
      Specifically in case of this task resource, the reason can also be that
      the task is not supported for the VNF instance represented by the parent
      resource, and that the task resource consequently does not exist.
      The "ProblemDetails" structure may be provided, including in the
      "detail" attribute information about the sourceof the problem, e.g. a
      wrong resource URI variable.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
  404-task-not-suported-VNF-LCM:
    description: >
      If the API producer did not find a current representation for the
      resource addressed by the URI passed in the request, or is not
      willing to disclose that one exists, it shall respond with this
      response code. 
      Specifically in case of this task resource, the reason can also be that
      the task is not supported for the VNF LCM operation occurrence
      represented by the parent resource, and that the task resource
      consequently does not exist.
      The "ProblemDetails" structure may be provided, including in the
      "detail" attribute information about the sourceof the problem, e.g. a
      wrong resource URI variable.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  405:
    description: >
      If a particular HTTP method is not supported for a particular
      resource, the API producer shall respond with this response code.
      The "ProblemDetails" structure may be omitted in that case.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  406:
    description: >
      If the "Accept" HTTP header does not contain at least one name of
      a content type that is acceptable to the API producer, the API
      producer shall respond with this response code. The
      "ProblemDetails" structure may be omitted in that case.        
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  412:
    description: >
      A precondition given in an HTTP request header is not fulfilled.
      Typically, this is due to an ETag mismatch, indicating that the
      resource was modified by another entity. The response body should
      contain a ProblemDetails structure, in which the "detail" attribute
      should convey more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"        
  416:
    description: >
      This code is returned if the requested byte range in the
      Range HTTP header is not present in the requested resource.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"               
  422:
    description: >
      If the payload body of a request contains syntactically correct
      data (e.g. well-formed JSON) but the data cannot be processed
      (e.g. because it fails validation against a schema), the API
      producer shall respond with this response code. The
      "ProblemDetails" structure shall be provided, and should include
      in the "detail" attribute more information about the source of the
      problem.
      NOTE 2: This error response code is only applicable for methods
      that have a request body.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  500:
    description: >
      If there is an application error not related to the client's input
      that cannot be easily mapped to any other HTTP response code
      ("catch all error"), the API producer shall respond withthis
      response code. The "ProblemDetails" structure shall be provided,
      and shall include in the "detail" attribute more information about
      the source of the problem.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  503:
    description: >
      If the API producer encounters an internal overload situation of
      itself or of a system it relies on, it should respond with this
      response code, following the provisions in IETF RFC 7231 [13] for
      the use of the "Retry-After" HTTP header and for the alternative
      to refuse the connection. The "ProblemDetails" structure may be omitted.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"