Commit cbd289bb authored by ETSI CTI's avatar ETSI CTI

Merge branch '2.7.1-dev' into 'master'

SOL005 OpenAPI representations for v2.7.1

See merge request !14
parents 0d258f2b 8886f39a
Pipeline #3231 passed with stage
in 0 seconds
# 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: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Fault Management Interface" title: "SOL005 - NS Fault Management Interface"
description: > description: >
SOL005 - NS Fault Management Interface SOL005 - NS Fault Management Interface
...@@ -16,8 +16,8 @@ info: ...@@ -16,8 +16,8 @@ info:
contact: contact:
name: "NFV-SOL WG" name: "NFV-SOL WG"
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.06.01_60/gs_NFV-SOL005v020701p.pdf
basePath: /nsfm/v1 basePath: /nsfm/v1
schemes: schemes:
- http - http
...@@ -30,14 +30,14 @@ paths: ...@@ -30,14 +30,14 @@ paths:
############################################################################### ###############################################################################
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/api-versions': '/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
############################################################################### ###############################################################################
# Alarms # # Alarms #
############################################################################### ###############################################################################
'/alarms': '/alarms':
#ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.2 #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.2
parameters: parameters:
- name: Authorization - name: Authorization
description: > description: >
...@@ -57,7 +57,9 @@ paths: ...@@ -57,7 +57,9 @@ paths:
description: > description: >
Get Alarm List. Get Alarm List.
The client can use this method to retrieve information about the alarm list. The API consumer can use this method to retrieve information about the alarm list.
This method shall follow the provisions specified in the Tables 8.4.2.3.2-1 and 8.4.2.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters: parameters:
- name: filter - name: filter
in: query in: query
...@@ -155,7 +157,7 @@ paths: ...@@ -155,7 +157,7 @@ paths:
# Individual alarm # # Individual alarm #
############################################################################### ###############################################################################
'/alarms/{alarmId}': '/alarms/{alarmId}':
#ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.3 #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.3
parameters: parameters:
- name: alarmId - name: alarmId
description: > description: >
...@@ -183,7 +185,9 @@ paths: ...@@ -183,7 +185,9 @@ paths:
get: get:
summary: Read individual alarm. summary: Read individual alarm.
description: > description: >
The client can use this method to read an individual alarm. The API consumer can use this method to read an individual alarm.
This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters: parameters:
- name: Accept - name: Accept
description: > description: >
...@@ -250,6 +254,8 @@ paths: ...@@ -250,6 +254,8 @@ paths:
Acknowledge Alarm Acknowledge Alarm
This method modifies an individual alarm resource. This method modifies an individual alarm resource.
This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters: parameters:
- name: body - name: body
in: body in: body
...@@ -282,7 +288,7 @@ paths: ...@@ -282,7 +288,7 @@ paths:
Shall be returned when the request has been accepted and completed. Shall be returned when the request has been accepted and completed.
The response body shall contain attribute modifications for an 'Individual alarm' The response body shall contain attribute modifications for an 'Individual alarm'
resource (see clause 8.5.2.4). resource (see clause 8.5.2.8).
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.
...@@ -318,6 +324,20 @@ paths: ...@@ -318,6 +324,20 @@ paths:
406: 406:
$ref: "../responses/SOL005_resp.yaml#/responses/406" $ref: "../responses/SOL005_resp.yaml#/responses/406"
409: 409:
description: >
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the "Individual alarm"
resource.
Typically, this is due to the fact that the alarm is
already in the state that is requested to be set (such
as trying to acknowledge an already-acknowledged
alarm).
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409" $ref: "../responses/SOL005_resp.yaml#/responses/409"
412: 412:
$ref: "../responses/SOL005_resp.yaml#/responses/412" $ref: "../responses/SOL005_resp.yaml#/responses/412"
...@@ -330,7 +350,7 @@ paths: ...@@ -330,7 +350,7 @@ paths:
#Subscriptions # #Subscriptions #
############################################################################## ##############################################################################
'/subscriptions': '/subscriptions':
#ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.4 #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.4
parameters: parameters:
- name: Authorization - name: Authorization
description: > description: >
...@@ -424,6 +444,8 @@ paths: ...@@ -424,6 +444,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/405" $ref: "../responses/SOL005_resp.yaml#/responses/405"
406: 406:
$ref: "../responses/SOL005_resp.yaml#/responses/406" $ref: "../responses/SOL005_resp.yaml#/responses/406"
422:
$ref: "../responses/SOL005_resp.yaml#/responses/422"
500: 500:
$ref: "../responses/SOL005_resp.yaml#/responses/500" $ref: "../responses/SOL005_resp.yaml#/responses/500"
503: 503:
...@@ -433,13 +455,10 @@ paths: ...@@ -433,13 +455,10 @@ paths:
description: > description: >
Query Subscription Information Query Subscription Information
The client can use this method to retrieve the list of active subscriptions The API consumer can use this method to retrieve the list of active subscriptions for alarms related to an NS subscribed
for alarms related to a NS subscribed by the client. by the API consumer. It can be used e.g. for resynchronization after error situations.
It can be used e.g. for resynchronization after error situations. This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2 for URI query parameters,
request and response data structures, and response codes.
This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2
for URI query parameters, request and response data structures, and response codes.
Table 8.4.4.3.2-1: URI query parameters supported.
parameters: parameters:
- name: filter - name: filter
in: query in: query
...@@ -477,15 +496,23 @@ paths: ...@@ -477,15 +496,23 @@ paths:
description: > description: >
200 OK 200 OK
The list of subscriptions has been queried successfully. Shall be returned when the list of subscriptions has
The response body shall contain in an array the representations of all active subscriptions of the been queried successfully.
functional block that invokes the method, i.e. zero or more representations of FM subscriptions, as The response body shall contain in an array the
representations of all active subscriptions of the
functional block that invokes the method, i.e. zero or
more representations of FM subscriptions, as
defined in clause 8.5.2.3. defined in clause 8.5.2.3.
If the "filter" URI parameter was supplied in the request, the data in the response body shall have If the "filter" URI parameter was supplied in the
been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. request, the data in the response body shall have
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for been transformed according to the rules specified in
this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.2.2 of ETSI GS NFV-SOL 013 [16].
clause 5.4.2.3 of ETSI GS NFV SOL 013. If the NFVO supports alternative 2 (paging)
according to clause 5.4.2.1 of ETSI
GS NFV-SOL 013 [16] for this resource, inclusion of
the Link HTTP header in this response shall follow
the provisions in clause 5.4.2.3 of ETSI
GS NFV-SOL 013 [16].
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.
...@@ -537,7 +564,7 @@ paths: ...@@ -537,7 +564,7 @@ paths:
# Individual subscription # # Individual subscription #
############################################################################### ###############################################################################
'/subscriptions/{subscriptionId}': '/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.5 #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.5
parameters: parameters:
- name: subscriptionId - name: subscriptionId
description: > description: >
...@@ -567,9 +594,10 @@ paths: ...@@ -567,9 +594,10 @@ paths:
description: > description: >
Query Subscription Information Query Subscription Information
The client can use this method for reading an individual subscription for alarms related to NSs subscribed The API consumer can use this method for reading an individual subscription for alarms related to NSs subscribed by
by the client. This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 the API consumer.
for URI query parameters, request and response data structures, and response codes This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters: parameters:
- name: Accept - name: Accept
description: > description: >
......
...@@ -10,7 +10,6 @@ definitions: ...@@ -10,7 +10,6 @@ definitions:
- id - id
- managedObjectId - managedObjectId
- alarmRaisedTime - alarmRaisedTime
- rootCauseFaultyComponent
- ackState - ackState
- perceivedSeverity - perceivedSeverity
- eventTime - eventTime
...@@ -35,19 +34,27 @@ definitions: ...@@ -35,19 +34,27 @@ definitions:
description: > description: >
The virtualised resources that are causing the NS The virtualised resources that are causing the NS
fault. It shall be present when the faulty component fault. It shall be present when the faulty component
is "NS Virtual Link" or "VNF". is "NS Virtual Link" (see clause 8.5.3.4).
$ref: "#/definitions/FaultyResourceInfo" $ref: "#/definitions/FaultyResourceInfo"
alarmRaisedTime: alarmRaisedTime:
description: > description: >
Alarm identifier. Time stamp indicating when the alarm is raised by the managed object.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
alarmChangedTime: alarmChangedTime:
description: > description: >
The time stamp indicating when the alarm was cleared. Time stamp indicating when the alarm was last
changed. It shall be present if the alarm has been updated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
alarmClearedTime: alarmClearedTime:
description: > description: >
Links to resources related to this notification. Time stamp indicating when the alarm was cleared.
It shall be present if the alarm has been cleared.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
alarmAcknowledgedTime:
description: >
Time stamp indicating when the alarm was
acknowledged. It shall be present if the alarm has
been acknowledged.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
ackState: ackState:
description: > description: >
...@@ -129,9 +136,11 @@ definitions: ...@@ -129,9 +136,11 @@ definitions:
New value of the "ackState" attribute in "Alarm". New value of the "ackState" attribute in "Alarm".
Permitted values: Permitted values:
- ACKNOWLEDGED - ACKNOWLEDGED
- UNACKNOWLEDGED
type: string type: string
enum: enum:
- ACKNOWLEDGED - ACKNOWLEDGED
- UNACKNOWLEDGED
EventType: EventType:
description: > description: >
The enumeration EventType represents those types of events that trigger The enumeration EventType represents those types of events that trigger
...@@ -268,8 +277,7 @@ definitions: ...@@ -268,8 +277,7 @@ definitions:
callbackUri: callbackUri:
description: > description: >
The URI of the endpoint to send the notification to. The URI of the endpoint to send the notification to.
type: string $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
format: url
_links: _links:
description: > description: >
Links for this resource. Links for this resource.
...@@ -300,8 +308,7 @@ definitions: ...@@ -300,8 +308,7 @@ definitions:
callbackUri: callbackUri:
description: > description: >
The URI of the endpoint to send the notification to. The URI of the endpoint to send the notification to.
type: string $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
format: url
authentication: authentication:
description: > description: >
Authentication parameters to configure the use of Authorization when sending notifications Authentication parameters to configure the use of Authorization when sending notifications
......
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 Notification interface" title: "SOL005 - NS Fault Management Notification interface"
description: > description: >
SOL005 - NS Fault Management Notification interface SOL005 - NS Fault Management Notification interface
...@@ -14,8 +14,8 @@ info: ...@@ -14,8 +14,8 @@ 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.06.01_60/gs_NFV-SOL005v020701p.pdf
basePath: /callback/v1 basePath: /callback/v1
...@@ -40,7 +40,7 @@ paths: ...@@ -40,7 +40,7 @@ paths:
parameters: parameters:
- name: alarmNotification - name: alarmNotification
description: > description: >
Information of a NS alarm. Information of an NS alarm.
in: body in: body
required: true required: true
schema: schema:
...@@ -104,9 +104,73 @@ paths: ...@@ -104,9 +104,73 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/500" $ref