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
Show whitespace changes
Inline Side-by-side
src/SOL005/NSDManagement/NSDManagement.yaml
View file @ 875bd4d7
......@@ -22,65 +22,72 @@ basePath: "/nsd/v1"
schemes:
- https
consumes:
- "application/json"
- "application/json"
produces:
- "application/json"
- "application/json"
paths:
###############################################################################
# NS Descriptors #
###############################################################################
###############################################################################
# NS Descriptors #
###############################################################################
'/ns_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
get:
summary: Query information about multiple NS descriptor resources.
description: >
"The GET method queries information about multiple NS descriptor resources.
The GET method queries information about multiple NS descriptor resources.
This method shall follow the provisions specified in the
Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters,
request and response data structures, and response codes."
request and response data structures, and response codes.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
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 OSS/BSS may supply filtering parameters.
All attribute names that appear in the NsdInfo and in data types referenced from
it shall be supported in attribute-based filtering parameters."
- name: "all_fields"
in: "query"
it shall be supported in attribute-based filtering parameters.
- name: all_fields
in: query
required: false
type: "string"
type: string
description: >
"Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter."
- name: "fields"
in: "query"
Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter.
- name: fields
in: query
required: false
type: "string"
type: string
description: >
"Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_fields"
in: "query"
Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter.
- name: exclude_fields
in: query
required: false
type: "string"
type: string
description: >
"Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_default"
in: "query"
Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter.
- name: exclude_default
in: query
required: false
type: "string"
type: string
description: >
"Indicates to exclude the following complex attributes from the response. See
Indicates to exclude the following complex attributes from the response. See
clause 4.3.3 for details. The VNFM shall support this parameter.
The following attributes shall be excluded from the NsdInfo structure in the
response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
userDefinedData."
userDefinedData.
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -117,7 +124,7 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -130,6 +137,12 @@ paths:
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: array
items:
......@@ -190,13 +203,13 @@ paths:
in: header
required: true
type: string
- name: "body"
in: "body"
- name: body
in: body
required: true
schema:
type: "object"
type: object
required:
- "CreateNsdInfoRequest"
- CreateNsdInfoRequest
properties:
CreateNsdInfoRequest:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
......@@ -214,19 +227,19 @@ paths:
HTTP header that contains the resource URI of the
new NS descriptor resource.
schema:
type: "object"
type: object
properties:
NsdInfo:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
headers:
Content-Type:
type: "string"
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -262,37 +275,37 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual NS Descriptor #
###############################################################################
###############################################################################
# Individual NS Descriptor #
###############################################################################
'/ns_descriptors/{nsdInfoId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
parameters:
- name: "nsdInfoId"
- name: nsdInfoId
description: >
Identifier of the individual NS descriptor resource.
in: "path"
in: path
required: true
type: "string"
type: string
get:
summary: Read information about an individual NS descriptor resource.
description: >
"The GET method reads information about an individual NS descriptor.
The GET method reads information about an individual NS descriptor.
This method shall follow the provisions specified in GS NFV-SOL 005 Tables
5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,
request and response data structures, and response codes."
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
Reference: IETF RFC 7235.
in: header
required: false
type: string
......@@ -311,18 +324,18 @@ paths:
The response body shall contain a representation of
the individual NS descriptor.
schema:
type: "object"
type: object
properties:
NsdInfo:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
headers:
Content-Type:
type: "string"
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -370,13 +383,13 @@ paths:
The usage state (i.e. "IN_USE/NOT_IN_USE") shall not changes a result.
3) Modify the user defined data of an individual NS descriptor resource.
parameters:
- name: "body"
in: "body"
- name: body
in: body
required: true
schema:
type: "object"
type: object
required:
- "NsdInfoModifications"
- NsdInfoModifications
properties:
NsdInfoModifications:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
......@@ -385,14 +398,14 @@ paths:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
Reference: IETF RFC 7231.
in: header
required: true
type: string
......@@ -418,7 +431,7 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -490,7 +503,7 @@ paths:
The response body shall be empty.
headers:
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -527,16 +540,16 @@ paths:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# NSD Content #
###############################################################################
###############################################################################
# NSD Content #
###############################################################################
'/ns_descriptors/{nsdInfoId}/nsd_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
parameters:
- name: "nsdInfoId"
in: "path"
- name: nsdInfoId
in: path
required: true
type: "string"
type: string
get:
summary: Fetch the content of a NSD.
description: >
......@@ -568,14 +581,14 @@ paths:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: "Range"
in: "header"
- name: Range
in: header
required: false
type: "string"
type: string
description: >
"The request may contain a "Range" HTTP header to obtain single
range of bytes from the NSD file. This can be used to continue an aborted
......@@ -610,7 +623,7 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -709,7 +722,7 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -754,9 +767,9 @@ paths:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# PNF Descriptors #
###############################################################################
###############################################################################
# PNF Descriptors #
###############################################################################
'/pnf_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
get:
......@@ -765,41 +778,41 @@ paths:
"The GET method queries information about multiple PNF descriptor
resources."
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
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 OSS/BSS may supply filtering parameters.
All attribute names that appear in the PnfdInfo and in data types referenced
from it shall be supported in attribute-based filtering parameters.
- name: "all_fields"
in: "query"
- name: all_fields
in: query
required: false
type: "string"
type: string
description: >
Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter.
- name: "fields"
in: "query"
- name: fields
in: query
required: false
type: "string"
type: string
description: >
Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter.
- name: "exclude_fields"
in: "query"
- name: exclude_fields
in: query
required: false
type: "string"
type: string
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter.
- name: "exclude_default"
in: "query"
- name: exclude_default
in: query
required: false
type: "string"
type: string
description: >
Indicates to exclude the following complex attributes from the response. See
clause 4.3.3 for details. The NFVO shall support this parameter.
......@@ -807,6 +820,13 @@ paths:
response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
userDefinedData.
- name: nextpage_opaque_marker
in: query
type: string
required: false
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
- name: Version
description: >
Version of the API requested to use when responding to this request.
......@@ -829,7 +849,7 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -842,8 +862,14 @@ paths:
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: "array"
type: array
items:
properties:
PnfdInfo:
......@@ -896,13 +922,13 @@ paths:
in: header
required: true
type: string
- name: "body"
in: "body"
- name: body
in: body
required: true
schema:
type: "object"
type: object
required:
- "CreatePnfdInfoRequest"
- CreatePnfdInfoRequest
properties:
CreatePnfdInfoRequest:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
......@@ -927,19 +953,19 @@ paths:
header that contains the resource URI of the new
PNF descriptor resource.
schema:
type: "object"
type: object
properties:
PnfdInfo:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
headers:
Content-Type:
type: "string"
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -976,18 +1002,18 @@ paths:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual PNF Descriptor #
###############################################################################
###############################################################################
# Individual PNF Descriptor #
###############################################################################
'/pnf_descriptors/{pnfdInfoId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
parameters:
- name: "pnfdInfoId"
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor resource.
in: "path"
in: path
required: true
type: "string"
type: string
get:
summary: Read an individual PNFD resource.
description: >
......@@ -996,18 +1022,18 @@ paths:
and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and
response data structures, and response codes.
parameters:
- name: "Accept"
in: "header"
- name: Accept
in: header
required: true
type: "string"
type: string
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
- name: "Authorization"
in: "header"
- name: Authorization
in: header
required: false
type: "string"
type: string
description: >
The authorization token for the request. Details are specified
in clause 4.5.3 of GS NFV-SOL 005.
......@@ -1032,7 +1058,7 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -1046,7 +1072,7 @@ paths:
maximum: 1
minimum: 1
schema:
type: "object"
type: object
properties:
PnfdInfo:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
......@@ -1117,25 +1143,25 @@ paths:
description: >
The PATCH method modifies the user defined data of an individual PNF descriptor resource.
parameters:
- name: "Accept"
in: "header"
- name: Accept
in: header
required: true
type: "string"
type: string
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
- name: "Content-Type"
in: "header"
- name: Content-Type
in: header
required: true
type: "string"
type: string
description: >
The MIME type of the body of the request. This header field
shall be present if the request has a non-empty message body.
- name: "Authorization"
in: "header"
- name: Authorization
in: header
required: false
type: "string"
type: string
description: >
The authorization token for the request. Details are specified in clause 4.5.3.
- name: Version
......@@ -1144,13 +1170,13 @@ paths:
in: header
required: true
type: string
- name: "body"
in: "body"
- name: body
in: body
required: true
schema:
type: "object"
type: object
required:
- "PnfdInfoModifications"
- PnfdInfoModifications
properties:
PnfdInfoModifications:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
......@@ -1165,19 +1191,19 @@ paths:
The response body shall contain attribute
modifications for an 'Individual PNF Descriptor' resource.
schema:
type: