Skip to content
GitLab
Commit fe5c5299 authored by moscatelli's avatar 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
Hide whitespace changes
Inline Side-by-side
src/SOL005/APIVersion/APIVersion.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - API version interface"
description: >
SOL005 - API version Interface
......
src/SOL005/NSDManagement/NSDManagement.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NSD Management Interface"
description: >
SOL005 - NSD Management Interface
......
src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: SOL005 - NSD Management Notification interface
description: >
SOL005 - NSD Management Notification interface
......
src/SOL005/NSFaultManagement/NSFaultManagement.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NS Fault Management Interface"
description: >
SOL005 - NS Fault Management Interface
......
src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NS Fault Management Notification interface"
description: >
SOL005 - NS Fault Management Notification interface
......
src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NS Lifecycle Management Interface"
description: >
SOL005 - NS Lifecycle Management Interface
......@@ -939,7 +939,7 @@ paths:
items:
properties:
NsLcmOpOcc:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -1294,7 +1294,7 @@ paths:
The response shall include a representation of the NS
lifecycle management operation occurrence resource.
schema:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
headers:
Content-Type:
type: string
......
src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml
View file @ fe5c5299
......@@ -36,26 +36,6 @@ definitions:
Cancellation mode to apply.
$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:
description: >
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:
Human-readable description of the NS instance to be created.
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:
description: >
This type represents a response for Query NS operation.
......@@ -389,17 +409,17 @@ definitions:
description: >
Link to the resource representing the NS instance to
which the notified change applies..
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the subscription that triggered this notification.
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
$ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
nslcmOpOcc:
description: >
Link to the lifecycle operation occurrence that this
notification is related to. Shall be present if there is a
related lifecycle operation occurrence
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
$ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
Version:
description: >
......@@ -781,7 +801,7 @@ definitions:
type: array
minItems: 1
items:
$ref: "SOL005_def.yaml#/definitions/CpProtocolInfo"
$ref: "#/definitions/CpProtocolInfo"
extLinkPortId:
description: >
Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo"
......@@ -844,7 +864,7 @@ definitions:
a load balancing algorithm and criteria).
$ref: "#/definitions/ForwardingBehaviourInputParameters"
cpPairInfo:
CpPairInfo:
description: >
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.
......@@ -3676,7 +3696,7 @@ definitions:
"operationState" was "FAILED_TEMP", this attribute shall be present
and contain error information, unless it has been requested to be
excluded via an attribute selector.
$ref: "#/definitions/ProblemDetails"
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
resourceChanges:
description: >
This attribute contains information about the cumulative
......
src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NS Lifecycle Management Notification interface"
description: >
SOL005 - NS Lifecycle Management Notification interface
......
src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NS Performance Management Interface"
description: >
SOL005 - NS Performance Management Interface
......
src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
version: "1.1.0"
title: "SOL005 - NS Performance Management Notification interface"
description: >
SOL005 - NS Performance Management Notification interface
......
src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml
View file @ fe5c5299
swagger: "2.0"
info:
version: "1.2.0"
title: "SOL005 - VNF Package Management Interface"
version: "1.1.0"
title: SOL005 - VNF Package Management Interface
description: >
SOL005 - VNF Package Management Interface
IMPORTANT: Please note that this file might be not aligned to the current
......@@ -13,75 +13,68 @@ info:
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: /vnfpkgm/v1
description: ETSI GS NFV-SOL 005 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/vnfpkgm/v1"
schemes:
- http
- https
consumes:
- application/json
- "application/json"
produces:
- application/json
- "application/json"
paths:
###############################################################################
# API Versions #
###############################################################################
'/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
get:
summary: Query VNF packages information.
description: >
description: >
The GET method queries the information of the VNF packages matching the filter.
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,
request and response data structures, and response codes.
parameters:
- name: filter
in: query
- name: "filter"
in: "query"
required: false
type: string
description: >
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI query string. The
OSS/BSS may supply this parameter.
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 VnfPkgInfo and in data types referenced from it shall
be supported by the NFVO in the filter expression.
- name: all_fields
in: query
be supported in attribute-based filtering parameters.
- name: "all_fields"
in: "query"
required: false
type: string
description: >
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
description: >
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
description: >
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
description: >
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.
......@@ -92,13 +85,6 @@ paths:
- additionalArtifacts
- userDefinedData
- 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
description: >
Content-Types that are acceptable for the response.
......@@ -112,51 +98,27 @@ paths:
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
type: string
responses:
200:
description: >
200 OK
Information about zero or more VNF packages was successfully queried.
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.
Information of the selected VNF packages.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
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
minimum: 0
schema:
type: array
items:
......@@ -184,48 +146,48 @@ paths:
post:
summary: Create a new individual VNF package resource.
description: >
description: >
The POST method creates a new individual VNF package resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
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
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
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
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "CreateVnfPkgInfoRequest"
properties:
CreateVnfPkgInfoRequest:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
description: >
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
responses:
201:
description: >
description: >
201 Created
An individual VNF package resource has been created successfully.
The response body shall contain a representation of
the new individual VNF package resource, as defined
......@@ -239,43 +201,36 @@ paths:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
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.
maximum: 1
minimum: 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
has provided an invalid authorization token.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
###############################################################################
# Individual VNF Package #
###############################################################################
###############################################################################
# Individual VNF Package #
###############################################################################
'/vnf_packages/{vnfPkgId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
parameters:
- name: vnfPkgId
- name: "vnfPkgId"
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: path
type: string
in: "path"
type: "string"
required: true
get:
summary: Read information about an individual VNF package.
description: >
description: >
The GET method reads the information of a VNF package.
parameters:
- name: Accept
......@@ -291,43 +246,32 @@ paths:
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
type: string
responses:
200:
description: >
200 OK
Information of the VNF package was read successfully.
The response body shall contain the VNF package
info representation defined in clause 9.5.2.5.
Information of the VNF package.
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
type: "object"
properties:
VnfPkgInfo:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
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
has provided an invalid authorization token.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -348,7 +292,7 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
delete:
summary: Delete an individual VNF package.
description: >
description: >
The DELETE method deletes an individual VNF Package resource.
parameters:
- name: Authorization
......@@ -357,20 +301,16 @@ paths:
Reference: IETF RFC 7235
in: header
required: false