Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
Samir Medjiah
committed
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
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"
Samir Medjiah
committed
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
moscatelli
committed
206:
description: >
206 PARTIAL CONTENT
moscatelli
committed
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
moscatelli
committed
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
moscatelli
committed
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.
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
177
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
272
273
274
275
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
moscatelli
committed
409:
moscatelli
committed
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
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"
Samir Medjiah
committed
413 PAYLOAD TOO LARGE
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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.
moscatelli
committed
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
moscatelli
committed
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"
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
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"