Commit efddef62 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

addressed comments from SOL WG

parent aa120ef4
Pipeline #8039 failed with stage
in 0 seconds
......@@ -131,7 +131,7 @@ paths:
409:
$ref: '#/components/responses/IndividualAlarm.Patch.409'
412:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
$ref: '#/components/responses/IndividualAlarm.Patch.412'
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
500:
......@@ -160,18 +160,7 @@ paths:
201:
$ref: '#/components/responses/Subscriptions.Post.200'
303:
# description: |
# 303 SEE OTHER
#
# Shall be returned when a subscription with the
# same callback URI 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 "Individual subscription" resource.
# The response body shall be empty.
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
$ref: '#/components/responses/Subscriptions.Post.303'
400:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
401:
......@@ -185,7 +174,7 @@ paths:
406:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: '#/components/responses/Subscriptions.Post.422'
500:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
503:
......@@ -485,6 +474,41 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualAlarm.Patch.412:
description: |
412 Precondition Failed
Shall be returned upon the following 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:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
Subscriptions.Get.200:
description: |
200 OK
......@@ -573,6 +597,94 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
Subscriptions.Post.303:
description: |
303 See Other
Shall be returned when a subscription with the
same callback URI 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 "Individual subscription" resource.
The response body shall be empty.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
Subscriptions.Post.422:
description: |
422 Unprocessable Entity
Shall be returned upon the following error: The
content type of the payload body is supported
and the payload body of a request contains
syntactically correct data but the data cannot be
processed.
The general cause for this error and its handling
is specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this resource, the response
code 422 shall also be returned if the VNFM has
tested the Notification endpoint as described in
clause 7.4.6.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
information about the error
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualSubscription.Get.200:
description: |
200 OK
......
......@@ -171,18 +171,7 @@ paths:
201:
$ref: '#/components/responses/Subscriptions.Post.201'
303:
# description: |
# 303 SEE OTHER
#
# Shall be returned when a subscription with the
# same callback URI 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 "Individual subscription" resource.
# The response body shall be empty.
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
$ref: '#/components/responses/Subscriptions.Post.303'
400:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
401:
......@@ -196,7 +185,7 @@ paths:
406:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: '#/components/responses/Subscriptions.Post.422'
500:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
503:
......@@ -501,7 +490,82 @@ components:
type: array
items:
$ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription
Subscriptions.Post.303:
description: |
303 See Other
Shall be returned when a subscription with
the same callback URI 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 "Individual
subscription" resource.
The response body shall be empty
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Subscriptions.Post.422:
description: |
422 Unprocessable Entity
Shall be returned when a subscription with
the same callback URI 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 "Individual
subscription" resource.
The response body shall be empty
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
maximum: 1
minimum: 1
content:
application/json:
schema:
$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Subscriptions.Get.200:
description: |
200 OK
......
......@@ -249,7 +249,7 @@ paths:
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/ManifestInIndividualVnfPackage.Get.406'
409:
$ref: '#/components/responses/ManifestInIndividualVnfPackage.Get.409'
416:
......@@ -286,7 +286,7 @@ paths:
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/ManifestInIndividualOnboardedVnfPackage.Get.406'
409:
$ref: '#/components/responses/ManifestInIndividualOnboardedVnfPackage.Get.409'
416:
......@@ -333,12 +333,7 @@ paths:
409:
$ref: '#/components/responses/IndividualVnfPackageContent.Get.409'
416:
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the "Range" header
# did not match any available byte range in the VNF package file (e.g. "access after end of file").
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualVnfPackageContent.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -378,12 +373,7 @@ paths:
409:
$ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.409'
416:
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the "Range" header
# did not match any available byte range in the VNF package file (e.g. "access after end of file").
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -427,7 +417,7 @@ paths:
409:
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.409'
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -468,7 +458,7 @@ paths:
409:
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.409'
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -512,14 +502,7 @@ paths:
409:
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.409'
416:
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the
# "Range" header did not match any available byte range in the artifact file
# (e.g. "access after end of file").
# The response body may contain a ProblemDetails structure.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -560,14 +543,7 @@ paths:
409:
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.409'
416:
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the
# "Range" header did not match any available byte range in the artifact file
# (e.g. "access after end of file").
# The response body may contain a ProblemDetails structure.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -592,15 +568,7 @@ paths:
201:
$ref: '#/components/responses/Subscriptions.Post.201'
303:
# description: |
# 303 SEE OTHER
# Shall be returned when a subscription with the same callback URI and the same filter
# already exists 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 "Individual subscription" resource.
# The response body shall be empty.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
$ref: '#/components/responses/Subscriptions.Post.303'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
......@@ -614,7 +582,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: '#/components/responses/Subscriptions.Post.422'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -1143,6 +1111,40 @@ components:
schema:
type: string
ManifestInIndividualVnfPackage.Get.406:
description: |
406 Not Acceptable
If the related request contained an "Accept" header
not compatible with the Content type "application/zip"
but the "include_signatures" flag was provided, the
NFVO shall respond with this response code.
The "ProblemDetails" structure may be included with
the "detail" attribute providing more information about
the error.
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
ManifestInIndividualVnfPackage.Get.409:
description: |
409 CONFLICT
......@@ -1227,6 +1229,40 @@ components:
schema:
type: string
ManifestInIndividualOnboardedVnfPackage.Get.406:
description: |
406 Not Acceptable
If the related request contained an "Accept" header
not compatible with the Content type "application/zip"
but the "include_signatures" flag was provided, the
NFVO shall respond with this response code.
The "ProblemDetails" structure may be included with
the "detail" attribute providing more information about
the error.
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
ManifestInIndividualOnboardedVnfPackage.Get.409:
description: |
409 CONFLICT
......@@ -1375,6 +1411,32 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualVnfPackageContent.Get.416:
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte
range passed in the "Range" header did not match
any available byte range in the VNF package file
(e.g. "access after end of file").
The response body may contain a ProblemDetails
structure
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageContent.Get.200:
description: |
200 OK
......@@ -1445,6 +1507,39 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualOnboardedVnfPackageContent.Get.416:
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte
range passed in the "Range" header did not match
any available byte range in the VNF package file
(e.g. "access after end of file").
The response body may contain a ProblemDetails
structure
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifact.Get.200:
description: |
200 OK
......@@ -1533,6 +1628,32 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualVnfPackageArtifact.Get.416:
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte
range passed in the "Range" header did not match
any available byte range in the artifact file
(e.g. "access after end of file").
The response body may contain a ProblemDetails
structure
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageArtifact.Get.409:
description: |
409 CONFLICT
......@@ -1573,6 +1694,32 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualOnboardedVnfPackageArtifact.Get.416:
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte
range passed in the "Range" header did not match
any available byte range in the artifact file
(e.g. "access after end of file").
The response body may contain a ProblemDetails
structure
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.
style: simple