SOL005_resp.yaml 31.8 KB
Newer Older
1
2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
3

4
responses:
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

  202-with-Location:
    description: >
      202 ACCEPTED

      The request was accepted for processing, but the processing has not
      been completed. The response body shall be empty.
      The HTTP response shall include a "Location" HTTP
      header that contains the URI of the newly-created
      "NS lifecycle operation occurrence" resource
      corresponding to the operation.
    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 NS 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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
  202-with-Location-empty:
    description: >
      202 ACCEPTED

      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
      "NS Descriptor operation occurrence" resource corresponding to the
      operation.
      The response body shall be empty.
    headers:
      Location:
        description: The resource URI of the created NS 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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1

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
  206:
    description: >
      206 PARTIAL CONTENT
    headers:
      Content-Type:
        description: >
          The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      Content-Range:
        description: >
          The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
        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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  303:
    description: >
      303 SEE OTHER
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1

129
130
  400:
    description: >
131
      400 BAD REQUEST
132
133
134
135

      400 code can be returned in the following specified cases, the specific cause has to be proper specified in the
      "ProblemDetails" structure to be returned.

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
      If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect
      query parameters or the payload body contains a syntactically incorrect data structure),
      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 response to a GET request which queries a container resource would be so big that the performance
      of the API producer is adversely affected, and the API producer does not support paging for the affected resource,
      it 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 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.

      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 IETF RFC 6750
      and IETF RFC 7235. The ProblemDetails structure may be provided.

      The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0
      for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
177
178
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
179
180
181

  401:
    description: >
182
      401 UNAUTHORIZED
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
      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 IETF RFC 6750
      and IETF RFC 7235. The ProblemDetails 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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
207
208
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
209
210
211

  403:
    description: >
212
      403 FORBIDDEN
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
      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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
237
238
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
239
240
241

  404:
    description: >
242
      404 NOT FOUND
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
      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.

      This response code is not appropriate in case the resource addressed by the URI is a container resource
      which is designed to contain child resources, but does not contain any child resource at the time
      the request is received. For a GET request to an existing empty container resource, a typical response
      contains a 200 OK response code and a payload body with an empty array.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
272
273
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
274
275
276

  405:
    description: >
277
      405 METHOD NOT ALLOWED
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
      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.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
300
301
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
302
303
304

  406:
    description: >
305
      406 NOT ACCEPTABLE
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
      If the "Accept" 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.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
329
330
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
  406-state-conflict:
    description: >
      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
      "onboardingState" of the VNF package has a value
      different from "ONBOARDED".
      The response body 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

365
366
367
  409:
    description: >
      409 CONFLICT
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609

      Error: The operation cannot be executed
      currently, due to a conflict with the state of
      the resource.
      Typically, this is due to any of the following
      scenarios:
      - Disable a VNF package resource of
      hich the operational state is not
      ENABLED
      - Enable a VNF package resource of
      which the operational state is not
      DISABLED
      The response body 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  409-another-nsd-operation-ongoing:
    description: >
      409 CONFLICT

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that another Descriptor operation is
      ongoing.
      The response body shall 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-inconsistent-state:
    description: >
      409 CONFLICT

      Another request is in progress that prohibits the fulfilment of
      the current request, or the current resource state is inconsistent
      with the request.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-INSTANTIATED:
    description: >
      409 CONFLICT

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that the NS instance resource is in
      INSTANTIATED state.
      The response body shall 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1        
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-not-FAILED_TEMP:
    description: >
      409 CONFLICT

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that the NS instance resource is
      not in FAILED_TEMP state, or another error handling action is starting,
      such as rollback or fail.
      The response body shall 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-NOT-INSTANTIATED:
    description: >
      409 CONFLICT

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that the NS instance resource is in
      NOT-INSTANTIATED state, or that another lifecycle management operation
      is ongoing.
      The response body shall 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-ONBOARDING:
    description: >
      409 CONFLICT

      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 "onboardingState"
      of the VNF package has a value different from "ONBOARDED".
      The response body 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-ONBOARDING-NOT-CREATED:
    description: >
      409 CONFLICT

      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 on boarding
      state of the VNF package resource is not CREATED .
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall convey
      more information about the error.
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  412:
    description: >
      412 PRECONDITION FAILED

      Error: 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

664
665
  413:
    description: >
666
      413 PAYLOAD TOO LARGE
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
      If the payload body of a request is larger than the amount of data the API producer is willing or able to process,
      it shall respond with this response code, following the provisions in IETF RFC 7231 for the use
      of the "Retry-After" HTTP header and for closing 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
690
691
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
692
693
694

  414:
    description: >
695
      414 URI TOO LONG
696
697
698
699
700
701
702
703
704
705
706
707
708
709
      If the request URI of a request is longer than the API producer is willing or able to process,
      it shall respond with this response code. This condition can e.g. be caused by passing long queries
      in the request URI of a GET request. 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
      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.
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
        type: string
        maximum: 1
        minimum: 0
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  416:
    description: >
      416 RANGE NOT SATISFIABLE
    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.
736
737
738
739
740
741
742
743
744
        type: string
        maximum: 1
        minimum: 0
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
745
746
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
747
748
749

  422:
    description: >
750
      422 UNPROCESSABLE ENTITY
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
      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.

      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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
777
778
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
779
780
781

  429:
    description: >
782
      429 TOO MANY REQUESTS
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
      If the API consumer has sent too many requests in a defined period of time and the API producer is able
      to detect that condition ("rate limiting"), the API producer shall respond with this response code,
      following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header.
      The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information
      about the source of the problem.

      The period of time and allowed number of requests are configured within the API producer by means
      outside the scope of the present document.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
811
812
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
813
814
815

  500:
    description: >
816
      500 INTERNAL SERVER ERROR
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
      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 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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
841
842
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
843
844
845

  503:
    description: >
846
      503 SERVICE UNAVAILABLE
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
      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 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
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
871
872
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
873
874
875

  504:
    description: >
876
      504 GATEWAY TIMEOUT
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
      If the API producer encounters a timeout while waiting for a response from an upstream server
      (i.e. a server that the API producer communicates with when fulfilling a request), it should respond
      with this response code.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
900
901
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"