Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NFV - Network Functions Virtualisation
SOL005
Commits
fe5c5299
Commit
fe5c5299
authored
Apr 16, 2019
by
moscatelli
Browse files
SOL005: OpenAPI version updated to 1.1.0 + broken references among files fixed
parent
8fe76a84
Pipeline
#767
failed with stage
in 0 seconds
Changes
16
Pipelines
1
Show whitespace changes
Inline
Side-by-side
src/SOL005/APIVersion/APIVersion.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
API
version
interface"
title
:
"
SOL005
-
API
version
interface"
description
:
>
description
:
>
SOL005 - API version Interface
SOL005 - API version Interface
...
...
src/SOL005/NSDManagement/NSDManagement.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NSD
Management
Interface"
title
:
"
SOL005
-
NSD
Management
Interface"
description
:
>
description
:
>
SOL005 - NSD Management Interface
SOL005 - NSD Management Interface
...
...
src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
SOL005 - NSD Management Notification interface
title
:
SOL005 - NSD Management Notification interface
description
:
>
description
:
>
SOL005 - NSD Management Notification interface
SOL005 - NSD Management Notification interface
...
...
src/SOL005/NSFaultManagement/NSFaultManagement.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NS
Fault
Management
Interface"
title
:
"
SOL005
-
NS
Fault
Management
Interface"
description
:
>
description
:
>
SOL005 - NS Fault Management Interface
SOL005 - NS Fault Management Interface
...
...
src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NS
Fault
Management
Notification
interface"
title
:
"
SOL005
-
NS
Fault
Management
Notification
interface"
description
:
>
description
:
>
SOL005 - NS Fault Management Notification interface
SOL005 - NS Fault Management Notification interface
...
...
src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NS
Lifecycle
Management
Interface"
title
:
"
SOL005
-
NS
Lifecycle
Management
Interface"
description
:
>
description
:
>
SOL005 - NS Lifecycle Management Interface
SOL005 - NS Lifecycle Management Interface
...
@@ -939,7 +939,7 @@ paths:
...
@@ -939,7 +939,7 @@ paths:
items
:
items
:
properties
:
properties
:
NsLcmOpOcc
:
NsLcmOpOcc
:
$ref
:
"
definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
$ref
:
"
definitions/
SOL005
NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
400
:
400
:
$ref
:
"
../responses/SOL005_resp.yaml#/responses/400"
$ref
:
"
../responses/SOL005_resp.yaml#/responses/400"
401
:
401
:
...
@@ -1294,7 +1294,7 @@ paths:
...
@@ -1294,7 +1294,7 @@ paths:
The response shall include a representation of the NS
The response shall include a representation of the NS
lifecycle management operation occurrence resource.
lifecycle management operation occurrence resource.
schema
:
schema
:
$ref
:
"
definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
$ref
:
"
definitions/
SOL005
NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
headers
:
headers
:
Content-Type
:
Content-Type
:
type
:
string
type
:
string
...
...
src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml
View file @
fe5c5299
...
@@ -36,26 +36,6 @@ definitions:
...
@@ -36,26 +36,6 @@ definitions:
Cancellation mode to apply.
Cancellation mode to apply.
$ref
:
"
#/definitions/CancelModeType"
$ref
:
"
#/definitions/CancelModeType"
CancelModeType
:
description
:
>
Cancellation mode.
The NFVO shall not start any new VNF lifecycle management and resource
management operation, and shall wait for the ongoing VNF lifecycle management
and resource management operations in the underlying system, typically the VNFM
and VIM, to finish execution or to time out. After that, the NFVO shall put the
operation occurrence into the FAILED_TEMP state.
The NFVO shall not start any new VNF lifecycle management and resource
management operation, shall cancel the ongoing VNF lifecycle management and
resource management operations in the underlying system, typically the VNFM and
VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO
shall put the operation occurrence into the FAILED_TEMP state.
type
:
string
enum
:
-
GRACEFUL
-
FORCEFUL
HealNsData
:
HealNsData
:
description
:
>
description
:
>
This type represents the information used to heal a NS.
This type represents the information used to heal a NS.
...
...
src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml
View file @
fe5c5299
...
@@ -22,6 +22,26 @@ definitions:
...
@@ -22,6 +22,26 @@ definitions:
Human-readable description of the NS instance to be created.
Human-readable description of the NS instance to be created.
type
:
string
type
:
string
CancelModeType
:
description
:
>
Cancellation mode.
The NFVO shall not start any new VNF lifecycle management and resource
management operation, and shall wait for the ongoing VNF lifecycle management
and resource management operations in the underlying system, typically the VNFM
and VIM, to finish execution or to time out. After that, the NFVO shall put the
operation occurrence into the FAILED_TEMP state.
The NFVO shall not start any new VNF lifecycle management and resource
management operation, shall cancel the ongoing VNF lifecycle management and
resource management operations in the underlying system, typically the VNFM and
VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO
shall put the operation occurrence into the FAILED_TEMP state.
type
:
string
enum
:
-
GRACEFUL
-
FORCEFUL
NsInstance
:
NsInstance
:
description
:
>
description
:
>
This type represents a response for Query NS operation.
This type represents a response for Query NS operation.
...
@@ -389,17 +409,17 @@ definitions:
...
@@ -389,17 +409,17 @@ definitions:
description
:
>
description
:
>
Link to the resource representing the NS instance to
Link to the resource representing the NS instance to
which the notified change applies..
which the notified change applies..
$ref
:
"
SOL005_def.yaml#/definitions/NotificationLink"
$ref
:
"
../../definitions/
SOL005_def.yaml#/definitions/NotificationLink"
subscription
:
subscription
:
description
:
>
description
:
>
Link to the subscription that triggered this notification.
Link to the subscription that triggered this notification.
$ref
:
"
SOL005_def.yaml#/definitions/NotificationLink"
$ref
:
"
"../../definitions/
SOL005_def.yaml#/definitions/NotificationLink"
nslcmOpOcc
:
nslcmOpOcc
:
description
:
>
description
:
>
Link to the lifecycle operation occurrence that this
Link to the lifecycle operation occurrence that this
notification is related to. Shall be present if there is a
notification is related to. Shall be present if there is a
related lifecycle operation occurrence
related lifecycle operation occurrence
$ref
:
"
SOL005_def.yaml#/definitions/NotificationLink"
$ref
:
"
"../../definitions/
SOL005_def.yaml#/definitions/NotificationLink"
Version
:
Version
:
description
:
>
description
:
>
...
@@ -781,7 +801,7 @@ definitions:
...
@@ -781,7 +801,7 @@ definitions:
type
:
array
type
:
array
minItems
:
1
minItems
:
1
items
:
items
:
$ref
:
"
SOL005_def.yaml
#/definitions/CpProtocolInfo"
$ref
:
"
#/definitions/CpProtocolInfo"
extLinkPortId
:
extLinkPortId
:
description
:
>
description
:
>
Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo"
Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo"
...
@@ -844,7 +864,7 @@ definitions:
...
@@ -844,7 +864,7 @@ definitions:
a load balancing algorithm and criteria).
a load balancing algorithm and criteria).
$ref
:
"
#/definitions/ForwardingBehaviourInputParameters"
$ref
:
"
#/definitions/ForwardingBehaviourInputParameters"
c
pPairInfo
:
C
pPairInfo
:
description
:
>
description
:
>
This type represents describes a pair of ingress and egress CPs or SAPs which
This type represents describes a pair of ingress and egress CPs or SAPs which
the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
...
@@ -3676,7 +3696,7 @@ definitions:
...
@@ -3676,7 +3696,7 @@ definitions:
"operationState" was "FAILED_TEMP", this attribute shall be present
"operationState" was "FAILED_TEMP", this attribute shall be present
and contain error information, unless it has been requested to be
and contain error information, unless it has been requested to be
excluded via an attribute selector.
excluded via an attribute selector.
$ref
:
"
#/definitions/ProblemDetails"
$ref
:
"
../../definitions/SOL005_def.yaml
#/definitions/ProblemDetails"
resourceChanges
:
resourceChanges
:
description
:
>
description
:
>
This attribute contains information about the cumulative
This attribute contains information about the cumulative
...
...
src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NS
Lifecycle
Management
Notification
interface"
title
:
"
SOL005
-
NS
Lifecycle
Management
Notification
interface"
description
:
>
description
:
>
SOL005 - NS Lifecycle Management Notification interface
SOL005 - NS Lifecycle Management Notification interface
...
...
src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NS
Performance
Management
Interface"
title
:
"
SOL005
-
NS
Performance
Management
Interface"
description
:
>
description
:
>
SOL005 - NS Performance Management Interface
SOL005 - NS Performance Management Interface
...
...
src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.0"
title
:
"
SOL005
-
NS
Performance
Management
Notification
interface"
title
:
"
SOL005
-
NS
Performance
Management
Notification
interface"
description
:
>
description
:
>
SOL005 - NS Performance Management Notification interface
SOL005 - NS Performance Management Notification interface
...
...
src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml
View file @
fe5c5299
swagger
:
"
2.0"
swagger
:
"
2.0"
info
:
info
:
version
:
"
1.
2
.0"
version
:
"
1.
1
.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
IMPORTANT: Please note that this file might be not aligned to the current
IMPORTANT: Please note that this file might be not aligned to the current
...
@@ -16,26 +16,19 @@ info:
...
@@ -16,26 +16,19 @@ info:
contact
:
contact
:
name
:
"
NFV-SOL
WG"
name
:
"
NFV-SOL
WG"
externalDocs
:
externalDocs
:
description
:
ETSI GS NFV-SOL 005 V2.
5
.1
description
:
ETSI GS NFV-SOL 005 V2.
4
.1
url
:
http
s
://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.0
5
.01_60/gs_NFV-SOL005v020
5
01p.pdf
url
:
http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.0
4
.01_60/gs_NFV-SOL005v020
4
01p.pdf
basePath
:
/vnfpkgm/v1
basePath
:
"
/vnfpkgm/v1
"
schemes
:
schemes
:
-
http
-
https
-
https
consumes
:
consumes
:
-
application/json
-
"
application/json
"
produces
:
produces
:
-
application/json
-
"
application/json
"
paths
:
paths
:
###############################################################################
###############################################################################
# API Versions #
# VNF Packages #
###############################################################################
###############################################################################
'
/api-versions'
:
$ref
:
'
../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
###############################################################################
# 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
:
...
@@ -46,41 +39,41 @@ paths:
...
@@ -46,41 +39,41 @@ paths:
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,
request and response data structures, and response codes.
request and response data structures, and response codes.
parameters
:
parameters
:
-
name
:
filter
-
name
:
"
filter
"
in
:
query
in
:
"
query
"
required
:
false
required
:
false
type
:
string
type
:
"
string
"
description
:
>
description
:
>
Attribute-based filtering
expression
according to clause 4.3.2.
Attribute-based filtering
parameters
according to clause 4.3.2.
The NFVO shall support receiving
this
parameter as part of the URI query string. The
The NFVO shall support receiving
filtering
parameter
s
as part of the URI query string. The
OSS/BSS may supply
this
parameter.
OSS/BSS may supply
filtering
parameter
s
.
All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
be supported
by the NFVO in the filter expression
.
be supported
in attribute-based filtering parameters
.
-
name
:
all_fields
-
name
:
"
all_fields
"
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.
...
@@ -92,13 +85,6 @@ paths:
...
@@ -92,13 +85,6 @@ paths:
- additionalArtifacts
- additionalArtifacts
- userDefinedData
- userDefinedData
- checksum
- checksum
-
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
-
name
:
Accept
description
:
>
description
:
>
Content-Types that are acceptable for the response.
Content-Types that are acceptable for the response.
...
@@ -113,24 +99,12 @@ paths:
...
@@ -113,24 +99,12 @@ paths:
in
:
header
in
:
header
required
:
false
required
:
false
type
:
string
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
responses
:
200
:
200
:
description
:
>
description
:
>
200 OK
200 OK
Information about zero or more VNF packages was successfully queried.
Information of the selected VNF packages.
The response body shall contain in an array the VNF package info
representations that match the attribute filter, i.e., zero or more
VNF package info representations as defined in clause 9.5.2.5.
If the NFVO supports alternative 2 (paging) according to
clause 4.7.2.1 for this resource, inclusion of the Link HTTP header
in this response shall follow the provisions in clause 4.7.2.3.
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.
...
@@ -138,25 +112,13 @@ paths:
...
@@ -138,25 +112,13 @@ paths:
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
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
has provided an invalid authorization token.
maximum
:
1
maximum
:
1
minimum
:
0
minimum
:
0
Version
:
description
:
>
Version of the API used in the response.
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
:
schema
:
type
:
array
type
:
array
items
:
items
:
...
@@ -208,19 +170,19 @@ paths:
...
@@ -208,19 +170,19 @@ paths:
in
:
header
in
:
header
required
:
true
required
:
true
type
:
string
type
:
string
-
name
:
Version
-
name
:
"
body"
description
:
>
in
:
"
body"
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
-
name
:
body
in
:
body
required
:
true
required
:
true
schema
:
schema
:
type
:
"
object"
required
:
-
"
CreateVnfPkgInfoRequest"
properties
:
CreateVnfPkgInfoRequest
:
$ref
:
"
definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
$ref
:
"
definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
description
:
>
description
:
>
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
responses
:
responses
:
201
:
201
:
description
:
>
description
:
>
...
@@ -239,7 +201,7 @@ paths:
...
@@ -239,7 +201,7 @@ paths:
$ref
:
"
definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
$ref
:
"
definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
headers
:
headers
:
Content-Type
:
Content-Type
:
type
:
string
type
:
"
string
"
description
:
>
description
:
>
The MIME type of the body of the response.This header
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
field shall be present if the response has a non-empty message
...
@@ -247,31 +209,24 @@ paths:
...
@@ -247,31 +209,24 @@ paths:
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
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
has provided an invalid authorization token.
maximum
:
1
maximum
:
1
minimum
:
0
minimum
:
0
Version
:
###############################################################################
description
:
>
# Individual VNF Package #
Version of the API used in the response.
###############################################################################
type
:
string
maximum
:
1
minimum
:
1
###############################################################################
# Individual VNF Package #
###############################################################################
'
/vnf_packages/{vnfPkgId}'
: