Commit efe5fa2f authored by moscatelli's avatar moscatelli
Browse files

SOL005: Common definitions file updated + NSD mgmt and NS Performance mgmt def files updated

parent 9f82be0a
Pipeline #652 passed with stage
in 0 seconds
......@@ -406,9 +406,9 @@ paths:
an already disabled individual NS descriptor resource, or the "nsdOnboardingState" is not ONBOARDED.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
412:
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
$ref: "../responses/SOL005_resp.yaml#/responses/412"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -477,7 +477,7 @@ paths:
NS descriptor resource (i.e. usageState = IN_USE).
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -587,7 +587,7 @@ paths:
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.
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/206"
$ref: "../responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -606,13 +606,13 @@ paths:
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.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
description: >
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.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -705,7 +705,7 @@ paths:
Typically, this is due to the fact that the NsdOnboardingState 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.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -1086,7 +1086,7 @@ paths:
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
412:
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
$ref: "../responses/SOL005_resp.yaml#/responses/412"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -1214,7 +1214,7 @@ paths:
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.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -1261,7 +1261,7 @@ paths:
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.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -1368,7 +1368,7 @@ paths:
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.
$ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/303"
$ref: "../responses/SOL005_resp.yaml#/responses/303"
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Identifier:
description: >
An identifier with the intention of being globally unique.
type: string
KeyValuePairs:
description: >
This type represents a list of key-value pairs. The order of the pairs in the list is not significant.
In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions
defined in clause 4 of IETF RFC 7159.
type: object
String:
description: >
This type represents stack of string values
type: string
Version:
description: >
A Version.
type: string
Uri:
description: >
String formatted according to IETF RFC 3986.
type: string
DateTime:
description: >
Date-time stamp.
Representation: String formatted according to IETF RFC 3339.
type: string
format: "date-time"
ProblemDetails:
#SOL005 location: 4.3.5.3-1
description: >
The definition of the general "ProblemDetails" data structure from
IETF RFC 7807 [19] is reproduced in this structure. Compared to the
general framework defined in IETF RFC 7807 [19], the "status" and
"detail" attributes are mandated to be included by the present document,
to ensure that the response contains additional textual information about
an error. IETF RFC 7807 [19] foresees extensibility of the
"ProblemDetails" type. It is possible that particular APIs in the present
document, or particular implementations, define extensions to define
additional attributes that provide more information about the error.
The description column only provides some explanation of the meaning to
Facilitate understanding of the design. For a full description, see
IETF RFC 7807 [19].
type: object
required:
- statussss
- detail
properties:
type:
description: >
A URI reference according to IETF RFC 3986 [5] that identifies the
problem type. It is encouraged that the URI provides human-readable
documentation for the problem (e.g. using HTML) when dereferenced.
When this member is not present, its value is assumed to be
"about:blank".
type: string
format: URI
title:
description: >
A short, human-readable summary of the problem type. It should not
change from occurrence to occurrence of the problem, except for
purposes of localization. If type is given and other than
"about:blank", this attribute shall also be provided.
A short, human-readable summary of the problem
type. It SHOULD NOT change from occurrence to occurrence of the
problem, except for purposes of localization (e.g., using
proactive content negotiation; see [RFC7231], Section 3.4).
type: string
status:
description: >
The HTTP status code for this occurrence of the problem.
The HTTP status code ([RFC7231], Section 6) generated by the origin
server for this occurrence of the problem.
type: integer
detail:
description: >
A human-readable explanation specific to this occurrence of the
problem.
type: string
instance:
description: >
A URI reference that identifies the specific occurrence of the
problem. It may yield further information if dereferenced.
type: string
format: URI
\ No newline at end of file
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses:
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
409:
description: >
409 CONFLICT
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"
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.
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"
\ No newline at end of file
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses:
202:
description: >
Accepted
The request was accepted for processing, but processing has not
been completed. The response shall have an empty payload body.
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
202-with-Location:
description: >
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 LCM 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
206:
description: >
Partial Content.
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-Range:
type: "string"
Content-Type:
type: "string"
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
303:
description: >
See Other
A subscription with the same callbackURI 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 subscription resource.
The response body shall be empty.
400:
description: >
Bad Request
Error: Invalid attribute-based filtering parameters.
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
400-attr-based-filtering-error:
description: >
Bad Request
Invalid attribute-based filtering parameters or Invalid attribute
selector.
It the request is malformed or syntactically incorrect (e.g. if the
request URI contains incorrect query parameters or a syntactically
incorrect payload body), 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 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.
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.
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
400-attr-selector:
description: >
Error: Invalid attribute selector.
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
401:
description: >
Unauthorized
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:
type: string
description: The MIME type of the body of the response.
WWW-Authenticate:
type: string
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.
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
403:
description: >
Forbidden
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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404:
description: >
Not Found
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404-task-resource-not-exists:
description: >
Not Found
Error: The API producer did not find a current representation for the
target resource or is not willing to disclose that one exists.
Specifically in case of this task resource, the response code 404 shall
also returned if the task is not supported for the NS instance
represented by the parent resource, which means that the task resource
consequently does not exist.
In this case, the response body shall be present, and 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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404-task-resource-not-exists-NSD:
description: >
Not Found
Error: The API producer did not find a current representation for the
target resource or is not willing to disclose that one exists.
Specifically in case of this task resource, the response code 404 shall
also be returned if the task is not supported for the NS LCM operation
occurrence represented by the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present, and 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
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404-task-not-suported:
description: >
Not Found
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.
Specifically in case of this task resource, the reason can also be that
the task is not supported for the NS instance represented by the parent
resource, and that the task resource consequently does not exist.
The "ProblemDetails" structure may be provided, including in the
"detail" attribute information about the sourceof the problem, e.g. a
wrong resource URI variable.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404-task-not-suported-NSD:
description: >
Not Found
If the API producer did not find a current representation for the