Skip to content
GitLab
Commit 44336082 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated response descriptions

parent b1c5eccc
Pipeline #7781 passed with stage
in 0 seconds
Expand all Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml
View file @ 44336082
...@@ -129,14 +129,7 @@ paths: ...@@ -129,14 +129,7 @@ paths:
406: 406:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
409: 409:
# description: | $ref: '#/components/responses/IndividualAlarm.Patch.409'
# 409 CONFLICT
#
# Shall be returned upon the following error: The operation cannot be executed currently,
# due to a conflict with the state of the "Individual alarm" resource.
# Typically, this is due to the fact that the alarm is already in the state that is
# requested to be set (such as trying to acknowledge an already-acknowledged alarm).
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
412: 412:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
422: 422:
...@@ -449,7 +442,49 @@ components: ...@@ -449,7 +442,49 @@ components:
application/json: application/json:
schema: schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications" $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
IndividualAlarm.Patch.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the "Individual alarm"
resource.
Typically, this is due to the fact that the alarm is
already in the state that is requested to be set (such
as trying to acknowledge an already-acknowledged
alarm).
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall 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
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Subscriptions.Get.200: Subscriptions.Get.200:
description: | description: |
200 OK 200 OK
......
src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml
View file @ 44336082
...@@ -57,11 +57,7 @@ paths: ...@@ -57,11 +57,7 @@ paths:
401: 401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403: 403:
#description: | $ref: '#/components/responses/Grants.Post.403'
# 403 FORBIDDEN
#
# Shall be returned upon the following error: The grant has been rejected.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404: 404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405: 405:
...@@ -101,11 +97,7 @@ paths: ...@@ -101,11 +97,7 @@ paths:
401: 401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403: 403:
#description: | $ref: '#/components/responses/IndividualGrant.Get.403'
# 403 FORBIDDEN
#
# Shall be returned upon the following error: The grant has been rejected.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404: 404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405: 405:
...@@ -217,6 +209,50 @@ components: ...@@ -217,6 +209,50 @@ components:
schema: schema:
type: string type: string
Grants.Post.403:
description: |
403 FORBIDDEN
Shall be returned upon the following error: The grant
has been rejected.
A ProblemDetails structure shall be included in the
response to provide more details about the rejection
in the "details" attribute.
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
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualGrant.Get.200: IndividualGrant.Get.200:
description: | description: |
200 OK 200 OK
...@@ -263,4 +299,40 @@ components: ...@@ -263,4 +299,40 @@ components:
style: simple style: simple
explode: false explode: false
schema: schema:
type: string type: string
\ No newline at end of file
IndividualGrant.Get.403:
description: |
403 FORBIDDEN
Shall be returned upon the following error: The grant
has been rejected.
A ProblemDetails structure shall be included in the
response to provide more details about the rejection in
the "details" attribute.
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
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml
View file @ 44336082
...@@ -143,7 +143,7 @@ paths: ...@@ -143,7 +143,7 @@ paths:
406: 406:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
409: 409:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 $ref: '#/components/responses/PackageContent.Get.409'
416: 416:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
422: 422:
...@@ -187,7 +187,7 @@ paths: ...@@ -187,7 +187,7 @@ paths:
406: 406:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
409: 409:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 $ref: '#/components/responses/IndividualArtifact.Get.409'
416: 416:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
422: 422:
...@@ -410,6 +410,46 @@ components: ...@@ -410,6 +410,46 @@ components:
type: string type: string
format: binary format: binary
PackageContent.Get.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact the "state" of the
VNF snapshot package has a value different from
"AVAILABLE".
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall 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
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualArtifact.Get.200: IndividualArtifact.Get.200:
description: | description: |
200 OK 200 OK
...@@ -494,4 +534,44 @@ components: ...@@ -494,4 +534,44 @@ components:
application/*: application/*:
schema: schema:
type: string type: string
format: binary format: binary
\ No newline at end of file
IndividualArtifact.Get.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact the "state" of the
VNF snapshot package has a value different from
"AVAILABLE".
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall 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
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
Supports Markdown
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