Commit 3363ad79 authored by moscatelli's avatar moscatelli
Browse files

NSD mgmt referenced to common response codes updated

parent e0b3181f
Pipeline #644 failed with stage
in 0 seconds
This diff is collapsed.
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses:
202-with-Location:
206:
description: >
Accepted
Partial Content.
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.
On success, if the NFVO supports range requests, a
single consecutive byte range from the content of the
NSD file is returned.
The response body shall contain the requested part of
the NSD file.
The "Content-Range" HTTP header shall be provided
according to IETF RFC 7233 [23].
The "Content-Type" HTTP header shall be set as
defined above for the "200 OK" response.
headers:
Content-Type:
description: The MIME type of the body of the response.
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
Content-Range:
description: >
The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
type: string
format: url
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
......@@ -27,23 +35,28 @@ responses:
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/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
202-with-Location-empty:
description: >
Accepted
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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.
303:
description: >
A subscription with the same callbackURI and the same filter already exits and the policy
of the NFVO 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.
headers:
Location:
description: The resource URI of the created NS instance
Content-Type:
description: The MIME type of the body of the response.
type: string
format: url
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
......@@ -52,6 +65,13 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
409:
description: >
Conflict
......@@ -80,67 +100,26 @@ responses:
type: string
maximum: 1
minimum: 0
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-another-nsd-operation-ongoing:
description: >
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:
Version:
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/SOL005_def.yaml#/definitions/ProblemDetails"
409-inconsistent-state:
description: >
Conflict
Another request is in progress that prohibits the fulfillment 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.
Version of the API used in 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/SOL005_def.yaml#/definitions/ProblemDetails"
409-state-conflict-INSTANTIATED:
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
412:
description: >
Conflict
Precondition Failed.
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 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.
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.
......@@ -155,98 +134,20 @@ responses:
type: string
maximum: 1
minimum: 0
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-state-conflict-not-FAILED_TEMP:
description: >
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:
Version:
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/SOL005_def.yaml#/definitions/ProblemDetails"
409-state-conflict-NOT-INSTANTIATED:
description: >
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.
Version of the API used in 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/SOL005_def.yaml#/definitions/ProblemDetails"
409-nsd-onboarding-state-NOT-ONBOARDED:
description: >
Conflict
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact "nsdOnboardingState"
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-pnfd-onboarding-state-NOT-ONBOARDED:
416:
description: >
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 pnfdOnboardingState
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.
The byte range passed in the "Range" header did not
match any available byte range in the NSD file (e.g. access after end of file).
The response body may contain a ProblemDetails structure.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -261,32 +162,11 @@ responses:
type: string
maximum: 1
minimum: 0
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-pnfd-onboarding-state-NOT-CREATED:
description: >
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
PnfdOnboardingState has a value other than CREATED.
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:
Version:
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.
Version of the API used in the response.
type: string
maximum: 1
minimum: 0
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
......@@ -45,8 +45,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
401:
description: >
......@@ -75,8 +75,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
403:
description: >
......@@ -105,8 +105,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404:
description: >
......@@ -140,8 +140,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
405:
description: >
......@@ -168,8 +168,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
406:
description: >
......@@ -197,8 +197,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
413:
description: >
......@@ -226,8 +226,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
414:
description: >
......@@ -255,8 +255,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
422:
description: >
......@@ -287,8 +287,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
429:
description: >
......@@ -321,8 +321,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
500:
description: >
......@@ -351,8 +351,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
503:
description: >
......@@ -381,8 +381,8 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
504:
description: >
......@@ -410,5 +410,5 @@ responses:
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment