Commit 8886f39a authored by Giacomo Bernini's avatar Giacomo Bernini Committed by ETSI CTI
Browse files

SOL005 OpenAPI representations for v2.7.1

parent 0d258f2b
# NFV SOL005 APIs # NFV SOL005 APIs
This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
for the APIs defined in ETSI NFV GSs [SOL005](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf). for the APIs defined in ETSI NFV GSs [SOL005](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf).
The APIs described in this repository are defined for the `Os-Ma-nfvo` reference point. The APIs described in this repository are defined for the `Os-Ma-nfvo` reference point.
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - API version interface" title: "SOL005 - API version interface"
description: > description: >
SOL005 - API version Interface SOL005 - API version Interface
...@@ -17,8 +17,8 @@ info: ...@@ -17,8 +17,8 @@ info:
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.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
schemes: schemes:
- http - http
...@@ -34,17 +34,17 @@ paths: ...@@ -34,17 +34,17 @@ paths:
############################################################################### ###############################################################################
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/nsd/api-versions': '/nsd/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nsfm/api-versions': '/nsfm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nslcm/api-versions': '/nslcm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nspm/api-versions': '/nspm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/vnfpkgm/api-versions': '/vnfpkgm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
\ No newline at end of file
This diff is collapsed.
...@@ -91,6 +91,28 @@ definitions: ...@@ -91,6 +91,28 @@ definitions:
type: array type: array
items: items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
archiveSecurityOption:
description: >
Signals the security option used by the NSD archive as defined
in clause 5.1 of ETSI GS NFV SOL 007.
Valid values: OPTION_1, OPTION_2
type: string
enum:
- OPTION_1
- OPTION_2
signingCertificate:
description: >
The singleton signing certificate if it is included as a file in the NSD archive.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
artifacts:
description: >
Information about NSD archive artifacts contained in the NSD archive.
This attribute shall not be present before the NSD archive content
is on-boarded. Otherwise, this attribute shall be present if the NSD
archive contains artifacts.
type: array
items:
$ref: "#/definitions/NsdArchiveArtifactInfo"
nsdOnboardingState: nsdOnboardingState:
description: > description: >
On boarding state of the individual NS descriptor resource. On boarding state of the individual NS descriptor resource.
...@@ -101,8 +123,8 @@ definitions: ...@@ -101,8 +123,8 @@ definitions:
clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
structure. structure.
It shall be present when the "nsdOnboardingState" It shall be present when the "nsdOnboardingState"
attribute is CREATED and the uploading or attribute is "ERROR", i.e. the uploading or processing has failed in NFVO,
processing fails in NFVO. unless it has been requested to be excluded via an attribute selector.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
nsdOperationalState: nsdOperationalState:
description: > description: >
...@@ -200,6 +222,28 @@ definitions: ...@@ -200,6 +222,28 @@ definitions:
manner. This attribute is invariant across versions manner. This attribute is invariant across versions
of PNFD. of PNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
archiveSecurityOption:
description: >
Signals the security option used by the PNFD archive as defined
in clause 5.1 of ETSI GS NFV SOL 004.
Valid values: OPTION_1, OPTION_2
type: string
enum:
- OPTION_1
- OPTION_2
signingCertificate:
description: >
The singleton signing certificate if it is included as a file in the PNFD archive.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
artifacts:
description: >
Information about PNFD archive artifacts contained in the PNFD archive.
This attribute shall not be present before the PNFD archive content is
on-boarded. Otherwise, this attribute shall be present if the PNFD archive
contains artifacts.
type: array
items:
$ref: "#/definitions/PnfdArchiveArtifactInfo"
pnfdOnboardingState: pnfdOnboardingState:
description: > description: >
On-boarding state of the individual PNF descriptor resource. On-boarding state of the individual PNF descriptor resource.
...@@ -209,8 +253,8 @@ definitions: ...@@ -209,8 +253,8 @@ definitions:
Failure details of current on-boarding procedure. Failure details of current on-boarding procedure.
See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
It shall be present when the It shall be present when the
pnfdOnboardingState attribute is CREATED pnfdOnboardingState attribute is "ERROR", i.e. the uploading or processing has failed
and the uploading or processing fails in the NFVO. in the NFVO, unless it has been requested to be excluded via an attribute selector.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
pnfdUsageState: pnfdUsageState:
description: > description: >
...@@ -455,6 +499,61 @@ definitions: ...@@ -455,6 +499,61 @@ definitions:
items: items:
$ref: "#/definitions/PnfdUsageStateType" $ref: "#/definitions/PnfdUsageStateType"
NsdArchiveArtifactInfo:
type: object
description: >
This type represents an artifact contained in an NSD archive.
It shall comply with provisions defined in Table 5.5.3.5-1.
required:
- artifactPath
- checksum
properties:
artifactPath:
description: >
Path in the NSD archive, which identifies the artifact and
also allows to access a copy of the artifact.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the artifact file.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
metadata:
description: >
The metadata of the artifact that are available in the NSD Archive,
such as Content type, size, creation date, etc.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
PnfdArchiveArtifactInfo:
type: object
description: >
This type represents an artifact contained in a PNFD archive.
It shall comply with provisions defined in Table 5.5.3.6-1.
required:
- artifactPath
- checksum
properties:
artifactPath:
description: >
Path in the PNFD archive, which identifies the artifact and
also allows to access a copy of the artifact.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the artifact file.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
nonManoArtifactSetId:
description: >
Non-MANO artifact set identifier of the non-MANO artifact set
to which the artifact belongs, as defined in clause 4.3.7 of
ETSI GS NFV-SOL 004. Shall be provided if the artifact is
a non-MANO artifact, and shall be omitted otherwise.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
metadata:
description: >
The metadata of the artifact that are available in the PNFD Archive,
such as Content type, size, creation date, etc.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
NsdOperationalStateType: NsdOperationalStateType:
type: string type: string
description: > description: >
...@@ -484,15 +583,17 @@ definitions: ...@@ -484,15 +583,17 @@ definitions:
The enumeration NsdOnboardingStateType shall comply with the provisions The enumeration NsdOnboardingStateType shall comply with the provisions
defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
state of the NSD. state of the NSD.
CREATED = The NSD information object is created. CREATED = The NSD information object has been created.
UPLOADING = The associated NSD content is being uploaded. UPLOADING = The associated NSD content is being uploaded.
PROCESSING = The associated NSD content is being processed, e.g. validation. PROCESSING = The associated NSD content is being processed, e.g. validation.
ONBOARDED = The associated NSD content is on-boarded. ONBOARDED = The associated NSD content has been on-boarded.
ERROR = There was an error during upload or processing of the NSD content.
enum: enum:
- CREATED - CREATED
- UPLOADING - UPLOADING
- PROCESSING - PROCESSING
- ONBOARDED - ONBOARDED
- ERROR
PnfdOnboardingStateType: PnfdOnboardingStateType:
type: string type: string
...@@ -500,15 +601,17 @@ definitions: ...@@ -500,15 +601,17 @@ definitions:
The enumeration PnfdOnboardingStateType shall comply with the provisions The enumeration PnfdOnboardingStateType shall comply with the provisions
defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
of the individual PNF descriptor resource. of the individual PNF descriptor resource.
CREATED = The PNF descriptor resource is created. CREATED = The PNF descriptor resource has been created.
UPLOADING = The associated PNFD content is being uploaded. UPLOADING = The associated PNFD content is being uploaded.
PROCESSING = The associated PNFD content is being processed, e.g. validation. PROCESSING = The associated PNFD content is being processed, e.g. validation.
ONBOARDED = The associated PNFD content is on-boarded. ONBOARDED = The associated PNFD content has been on-boarded.
ERROR = There was an error during upload or processing of the associated PNFD content.
enum: enum:
- CREATED - CREATED
- UPLOADING - UPLOADING
- PROCESSING - PROCESSING
- ONBOARDING - ONBOARDING
- ERROR
PnfdUsageStateType: PnfdUsageStateType:
type: string type: string
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL005 - NSD Management Notification interface title: SOL005 - NSD Management Notification interface
description: > description: >
SOL005 - NSD Management Notification interface SOL005 - NSD Management Notification interface
...@@ -14,10 +14,10 @@ info: ...@@ -14,10 +14,10 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 005 V2.6.1 description: ETSI GS NFV-SOL 005 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
basePath: /callback/v1 basePath: /callback/v2
schemes: schemes:
- http - http
...@@ -51,11 +51,7 @@ paths: ...@@ -51,11 +51,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -122,12 +118,8 @@ paths: ...@@ -122,12 +118,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
...@@ -199,11 +191,7 @@ paths: ...@@ -199,11 +191,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -270,12 +258,8 @@ paths: ...@@ -270,12 +258,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
...@@ -347,11 +331,7 @@ paths: ...@@ -347,11 +331,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -418,12 +398,8 @@ paths: ...@@ -418,12 +398,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
...@@ -495,11 +471,7 @@ paths: ...@@ -495,11 +471,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -566,12 +538,8 @@ paths: ...@@ -566,12 +538,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
...@@ -643,11 +611,7 @@ paths: ...@@ -643,11 +611,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -714,12 +678,8 @@ paths: ...@@ -714,12 +678,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
...@@ -791,11 +751,7 @@ paths: ...@@ -791,11 +751,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -862,12 +818,8 @@ paths: ...@@ -862,12 +818,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
...@@ -939,11 +891,7 @@ paths: ...@@ -939,11 +891,7 @@ paths:
post: post:
summary: Notify about NSD and PNFD changes summary: Notify about NSD and PNFD changes
description: > description: >
This resource represents a notification endpoint. The server can use The POST method delivers a notification from the API producer to the API consumer.
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
response data structures, and response codes, as response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2. specified in the Table 5.4.10.3.1-2.
...@@ -1010,12 +958,8 @@ paths: ...@@ -1010,12 +958,8 @@ paths:
get: get:
summary: Test the notification endpoint summary: Test the notification endpoint
description: > description: >
This resource represents a notification endpoint. The server can use The GET method allows the API producer to test the notification endpoint
this resource to send notifications to a subscribed that is provided by the API consumer, e.g. during subscription.
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, This method shall follow the provisions specified in the Table 5.4.10.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:
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Fault Management Interface" title: "SOL005 - NS Fault Management Interface"
description: > description: >