Skip to content
GitLab
Commit 875bd4d7 authored by moscatelli's avatar moscatelli
Browse files

SOL005_8: Link and nextpage_opaque_marker added in NS mgmt and NS performarce... 

SOL005_8: Link and nextpage_opaque_marker added in NS mgmt and NS performarce mgmt GET requests + code formatting
parent c2da30f6
Pipeline #512 failed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL005/NSPerformanceManagement/responses/SOL005_resp.yaml
View file @ 875bd4d7
# Copyright (c) ETSI 2017. # Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt # https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses: responses:
303: 303:
description: > description: >
See Other. See Other.
A subscription with the same callbackURI and the A subscription with the same callbackURI and the
same filter already exits and the policy of the NFVO is same filter already exits and the policy of the NFVO is
to not create redundant subscriptions. to not create redundant subscriptions.
The HTTP response shall include a "Location" HTTP The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the existing header that contains the resource URI of the existing
subscription resource. subscription resource.
The response body shall be empty. The response body shall be empty.
400: 400:
description: > description: >
Bad Request. Bad Request.
Error: Invalid attribute-based filtering parameters. Error: Invalid attribute-based filtering parameters.
The response body shall contain a ProblemDetails The response body shall contain a ProblemDetails
structure, in which the "detail" attribute should convey structure, in which the "detail" attribute should convey
more information about the error. more information about the error.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
WWW-Authenticate: WWW-Authenticate:
description: > description: >
Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token. request has provided an invalid authorization token.
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
400-attr-based-filtering-error: 400-attr-based-filtering-error:
description: > description: >
Bad Request Bad Request
Invalid attribute-based filtering parameters or Invalid attribute Invalid attribute-based filtering parameters or Invalid attribute
selector. selector.
It the request is malformed or syntactically incorrect (e.g. if the It the request is malformed or syntactically incorrect (e.g. if the
request URI contains incorrect query parameters or a syntactically request URI contains incorrect query parameters or a syntactically
incorrect payload body), the API producer shall respond with this incorrect payload body), the API producer shall respond with this
response code. The "ProblemDetails" structure shall be provided, response code. The "ProblemDetails" structure shall be provided,
and should include in the "detail" attribute more information about and should include in the "detail" attribute more information about
the source of the problem. the source of the problem.
If the request contains a malformed access token, the API producer If the request contains a malformed access token, the API producer
should respond with this response. The details of the error shall should respond with this response. The details of the error shall
be returned in the WWW-Authenticate HTTP header, as defined in be returned in the WWW-Authenticate HTTP header, as defined in
IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be
provided. provided.
If there is an application error related to the client's input that 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 cannot be easily mapped to any other HTTP response code ("catch all
error"), the API producer shall respond with this response code.The error"), the API producer shall respond with this response code.The
"ProblemDetails" structure shall be provided, and shall include in "ProblemDetails" structure shall be provided, and shall include in
the "detail" attribute more information about the source of the the "detail" attribute more information about the source of the
problem. problem.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
WWW-Authenticate: WWW-Authenticate:
description: > description: >
Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token. request has provided an invalid authorization token.
type: string type: string
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
401: 401:
description: > description: >
Unauthorized. Unauthorized.
If the request contains no access token even though one is If the request contains no access token even though one is
required, or if the request contains an authorization token that required, or if the request contains an authorization token that
is invalid (e.g. expired or revoked), the API producer should is invalid (e.g. expired or revoked), the API producer should
respond with this response. The details of the error shall be respond with this response. The details of the error shall be
returned in the WWW-Authenticate HTTP header, as defined in returned in the WWW-Authenticate HTTP header, as defined in
IETF RFC 6750 and IETF RFC 7235. The ProblemDetails IETF RFC 6750 and IETF RFC 7235. The ProblemDetails
structure may be provided. structure may be provided.
headers: headers:
Content-Type: Content-Type:
type: string type: string
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
WWW-Authenticate: WWW-Authenticate:
type: string type: string
description: > description: >
Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token. request has provided an invalid authorization token.
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
403: 403:
description: > description: >
Forbidden Forbidden
If the API consumer is not allowed to perform a particular request If the API consumer is not allowed to perform a particular request
to a particular resource, the API producer shall respond with this to a particular resource, the API producer shall respond with this
response code. The "ProblemDetails" structure shall be provided. response code. The "ProblemDetails" structure shall be provided.
It should include in the "detail" attribute information about the It should include in the "detail" attribute information about the
source of the problem, and may indicate how to solve it. source of the problem, and may indicate how to solve it.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404: 404:
description: > description: >
Not Found Not Found
If the API producer did not find a current representation for the If the API producer did not find a current representation for the
resource addressed by the URI passed in the request, or is not resource addressed by the URI passed in the request, or is not
willing to disclose that one exists, it shall respond with this willing to disclose that one exists, it shall respond with this
response code. response code.
The "ProblemDetails" structure may be provided, The "ProblemDetails" structure may be provided,
including in the "detail" attribute information about the source including in the "detail" attribute information about the source
of the problem, e.g. a wrong resource URI variable. of the problem, e.g. a wrong resource URI variable.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404-task-resource-not-exists: 404-task-resource-not-exists:
description: > description: >
Not Found Not Found
Error: The API producer did not find a current representation for the Error: The API producer did not find a current representation for the
target resource or is not willing to disclose that one exists. target resource or is not willing to disclose that one exists.
Specifically in case of this task resource, the response code 404 shall Specifically in case of this task resource, the response code 404 shall
also returned if the task is not supported for the NS instance also returned if the task is not supported for the NS instance
represented by the parent resource, which means that the task resource represented by the parent resource, which means that the task resource
consequently does not exist. consequently does not exist.
In this case, the response body shall be present, and shall contain a In this case, the response body shall be present, and shall contain a
ProblemDetails structure, in which the "detail" attribute shall convey ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error. more information about the error.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
404-task-not-suported: 404-task-not-suported:
description: > description: >
Not Found Not Found
If the API producer did not find a current representation for the If the API producer did not find a current representation for the
resource addressed by the URI passed in the request, or is not resource addressed by the URI passed in the request, or is not
willing to disclose that one exists, it shall respond with this willing to disclose that one exists, it shall respond with this
response code. response code.
Specifically in case of this task resource, the reason can also be that 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 the task is not supported for the NS instance represented by the parent
resource, and that the task resource consequently does not exist. resource, and that the task resource consequently does not exist.
The "ProblemDetails" structure may be provided, including in the The "ProblemDetails" structure may be provided, including in the
"detail" attribute information about the sourceof the problem, e.g. a "detail" attribute information about the sourceof the problem, e.g. a
wrong resource URI variable. wrong resource URI variable.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
405: 405:
description: > description: >
Method Not Allowed Method Not Allowed
If a particular HTTP method is not supported for a particular If a particular HTTP method is not supported for a particular
resource, the API producer shall respond with this response code. resource, the API producer shall respond with this response code.
The "ProblemDetails" structure may be omitted in that case. The "ProblemDetails" structure may be omitted in that case.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
406: 406:
description: > description: >
If the "Accept" header does not contain at least one If the "Accept" header does not contain at least one
name of a content type for which the NFVO can name of a content type for which the NFVO can
provide a representation of the VNFD, the NFVO provide a representation of the VNFD, the NFVO
shall respond with this response code. shall respond with this response code.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
416: 416:
description: > description: >
The byte range passed in the "Range" header did not The byte range passed in the "Range" header did not
match any available byte range in the NSD file (e.g. match any available byte range in the NSD file (e.g.
"access after end of file"). "access after end of file").
The response body may contain a ProblemDetails structure. The response body may contain a ProblemDetails structure.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
500: 500:
description: > description: >
Internal Server Error Internal Server Error
If there is an application error not related to the client's input If there is an application error not related to the client's input
that cannot be easily mapped to any other HTTP response code that cannot be easily mapped to any other HTTP response code
("catch all error"), the API producer shall respond withthis ("catch all error"), the API producer shall respond withthis
response code. The ProblemDetails structure shall be provided, response code. The ProblemDetails structure shall be provided,
and shall include in the "detail" attribute more information about and shall include in the "detail" attribute more information about
the source of the problem. the source of the problem.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
503: 503:
description: > description: >
Service Unavailable Service Unavailable
If the API producer encounters an internal overload situation of If the API producer encounters an internal overload situation of
itself or of a system it relies on, it should respond with this itself or of a system it relies on, it should respond with this
response code, following the provisions in IETF RFC 7231 [13] for response code, following the provisions in IETF RFC 7231 [13] for
the use of the Retry-After HTTP header and for the alternative the use of the Retry-After HTTP header and for the alternative
to refuse the connection. The "ProblemDetails" structure may be omitted. to refuse the connection. The "ProblemDetails" structure may be omitted.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file \ No newline at end of file
src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml
View file @ 875bd4d7
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.0.0" version: "1.0.0"
title: SOL005 - VNF Package Management Interface title: SOL005 - VNF Package Management Interface
description: > description: >
SOL005 - VNF Package Management Interface SOL005 - VNF Package Management Interface
...@@ -13,7 +13,7 @@ info: ...@@ -13,7 +13,7 @@ info:
license: license:
name: "ETSI Forge copyright notice" name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: contact:
name: "NFV-SOL WG" name: "NFV-SOL WG"
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1 description: ETSI GS NFV-SOL 005 V2.4.1
...@@ -24,16 +24,16 @@ schemes: ...@@ -24,16 +24,16 @@ schemes:
consumes: consumes:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
paths: paths:
############################################################################### ###############################################################################
# VNF Packages # # VNF Packages #
############################################################################### ###############################################################################
'/vnf_packages': '/vnf_packages':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2 #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
get: get:
summary: Query VNF packages information. summary: Query VNF packages information.
description: > description: >
The GET method queries the information of the VNF packages matching the filter. The GET method queries the information of the VNF packages matching the filter.
This method shall follow the provisions specified in the This method shall follow the provisions specified in the
Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters, Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
...@@ -43,7 +43,7 @@ paths: ...@@ -43,7 +43,7 @@ paths:
in: "query" in: "query"
required: false required: false
type: "string" type: "string"
description: > description: >
Attribute-based filtering parameters according to clause 4.3.2. Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string. The The NFVO shall support receiving filtering parameters as part of the URI query string. The
OSS/BSS may supply filtering parameters. OSS/BSS may supply filtering parameters.
...@@ -53,28 +53,28 @@ paths: ...@@ -53,28 +53,28 @@ paths:
in: "query" in: "query"
required: false required: false
type: "string" type: "string"
description: > description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
shall support this parameter. shall support this parameter.
- name: "fields" - name: "fields"
in: "query" in: "query"
required: false required: false
type: "string" type: "string"
description: > description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter. NFVO should support this parameter.
- name: "exclude_fields" - name: "exclude_fields"
in: "query" in: "query"
required: false required: false
type: "string" type: "string"
description: > description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details. The Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
NFVO should support this parameter. NFVO should support this parameter.
- name: "exclude_default" - name: "exclude_default"
in: "query" in: "query"
required: false required: false
type: "string" type: "string"
description: > description: >
Indicates to exclude the following complex attributes from the response. See clause 4.3.3 Indicates to exclude the following complex attributes from the response. See clause 4.3.3
for details. for details.
The NFVO shall support this parameter. The NFVO shall support this parameter.
...@@ -98,12 +98,12 @@ paths: ...@@ -98,12 +98,12 @@ paths:
Reference: IETF RFC 7235 Reference: IETF RFC 7235
in: header in: header
required: false required: false
type: string type: string
responses: responses:
200: 200:
description: > description: >
200 OK 200 OK
Information of the selected VNF packages. Information of the selected VNF packages.
headers: headers:
Content-Type: Content-Type:
...@@ -111,20 +111,20 @@ paths: ...@@ -111,20 +111,20 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
WWW-Authenticate: WWW-Authenticate:
type: "string" type: "string"
description: > description: >
Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request