Commit 8717bdd9 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Merge branch '3.5.1-dev' into 'master'

merge 3.5.1 dev into master

See merge request !3
parents 0eb17265 b5509559
Pipeline #9054 running with stage
# NFV SOL009 - OpenAPIs for the management of NFV-MANO # NFV SOL009 - OpenAPIs for the management of NFV-MANO
This repository contains OpenAPIs for ETSI GS NFV-SOL 009, RESTful protocols This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v3.5.1, RESTful protocols
specification for the management of NFV-MANO. specification for the management of NFV-MANO functional entities.
**IMPORTANT: In case of discrepancies the published ETSI Group Specification takes precedence.** **IMPORTANT: These [OpenAPI](https://www.openapis.org/) specifications are in development phase. In case of discrepancies the published ETSI Group Specification takes precedence.**
More information at [NFV Solutions wiki](https://nfvwiki.etsi.org/index.php?title=NFV_Solutions). More information at [NFV Solutions wiki](https://nfvwiki.etsi.org/index.php?title=NFV_Solutions).
......
openapi: 3.0.2 openapi: 3.0.2
info: info:
version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - API version interface title: SOL009 - API version interface
description: |
description: >
SOL009 - API version Interface SOL009 - API version Interface
IMPORTANT: Please note that this file might IMPORTANT: Please note that this file might be not aligned to the current
be not aligned to the current version of the ETSI Group Specification it version of the ETSI Group Specification it refers to. In case of
refers to and has not been approved by the ETSI NFV ISG. In case of
discrepancies the published ETSI Group Specification takes precedence. discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to
https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license: Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: contact:
name: NFV-SOL WG name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1 description: ETSI GS NFV-SOL 009 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
paths: paths:
/nfvmanocim/api_versions: /nfvmanocim/api_versions:
......
openapi: 3.0.2 openapi: 3.0.2
info: info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Configuration and Information Management Notification Interface
title: SOL009 - NFV-MANO Configuration and Information Management Notification Operation description: |
description: > SOL009 - NFV-MANO Configuration and Information Management Notification Interface
SOL009 - NFV-MANO Configuration and Information Management Notification Operation
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
version of the ETSI Group Specification it refers to and has not been version of the ETSI Group Specification it refers to. In case of
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI discrepancies the published ETSI Group Specification takes precedence.
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
contact:
name: NFV-SOL WG
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
name: NFV-SOL WG
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1 description: ETSI GS NFV-SOL 009 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
servers: servers:
- url: http://0.0.0.0/callback/v1 - url: http://127.0.0.1/callback/v2
description: > - url: https://127.0.0.1/callback/v2
API HTTP Server
- url: https://0.0.0.0/callback/v1
description: >
API HTTPS Server
paths: paths:
/URI-is-provided-by-the-client-when-creating-the-subscription-ConfigurationAndInformationNotification: /URI_is_provided_by_the_client_when_creating_the_subscription-ConfigurationAndInformationNotification:
description: > description: >
This resource represents a notification endpoint. The API producer can use this This resource represents a notification endpoint. The API producer can use this
resource to send notifications related to NFV-MANO configuration and information resource to send notifications related to NFV-MANO configuration and information
...@@ -36,9 +35,9 @@ paths: ...@@ -36,9 +35,9 @@ paths:
resource during the subscription process. resource during the subscription process.
post: post:
description: > description: >
The POST method delivers a notification from the API producer to an API consumer. The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription" The API consumer shall have previously created an "Individual subscription" resource
resource with a matching filter. with a matching filter. See clause 5.5.6.3.1.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
...@@ -47,7 +46,7 @@ paths: ...@@ -47,7 +46,7 @@ paths:
$ref: "#/components/requestBodies/ConfigurationAnfInformationNotification" $ref: "#/components/requestBodies/ConfigurationAnfInformationNotification"
responses: responses:
"204": "204":
$ref: "#/components/responses/notification.post.204" $ref: "#/components/responses/Notification.Post.204"
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -72,14 +71,14 @@ paths: ...@@ -72,14 +71,14 @@ paths:
get: get:
description: > description: >
TThe GET method allows the API producer to test the notification endpoint that TThe GET method allows the API producer to test the notification endpoint that
is provided by the API consumer, e.g., during the subscription process. is provided by the API consumer, e.g., during the subscription process. See clause 5.5.6.3.2.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses: responses:
"204": "204":
$ref: "#/components/responses/notification.get.204" $ref: "#/components/responses/Notification.Get.204"
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -103,7 +102,7 @@ paths: ...@@ -103,7 +102,7 @@ paths:
components: components:
responses: responses:
notification.post.204: Notification.Post.204:
description: > description: >
204 NO CONTENT 204 NO CONTENT
...@@ -122,7 +121,7 @@ components: ...@@ -122,7 +121,7 @@ components:
schema: schema:
type: string type: string
notification.get.204: Notification.Get.204:
description: > description: >
204 NO CONTENT 204 NO CONTENT
...@@ -165,6 +164,15 @@ components: ...@@ -165,6 +164,15 @@ components:
configuration and information of the NFV-MANO functional entity configuration and information of the NFV-MANO functional entity
have been changed. have been changed.
type: object type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
properties: properties:
id: id:
description: > description: >
...@@ -213,20 +221,21 @@ components: ...@@ -213,20 +221,21 @@ components:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required: required:
- self - self
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
ChangeStateNotification: ChangeStateNotification:
description: > description: >
This type represents a Change state operation occurrence. This type represents a Change state operation occurrence.
type: object type: object
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
properties: properties:
id: id:
description: > description: >
...@@ -298,14 +307,4 @@ components: ...@@ -298,14 +307,4 @@ components:
required: required:
- subscription - subscription
- objectInstance - objectInstance
- changeStateOpOcc - changeStateOpOcc
required: \ No newline at end of file
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
\ No newline at end of file
openapi: 3.0.2 openapi: 3.0.2
info: info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Fault Management interface title: SOL009 - NFV-MANO Fault Management interface
description: > description: |
SOL009 - NFV-MANO Fault Management interface SOL009 - NFV-MANO Fault Management interface
IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= contact:
name: NFV-SOL WG
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1 description: ETSI GS NFV-SOL 009 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
servers: servers:
- url: http://127.0.0.1/nfvmanofm/v1 - url: http://127.0.0.1/nfvmanofm/v1
...@@ -26,10 +33,7 @@ paths: ...@@ -26,10 +33,7 @@ paths:
/alarms: /alarms:
get: get:
description: > description: >
Get Alarm List. The client can use this method to retrieve information The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2.
about the alarm list. This method shall follow the provisions specified
in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
...@@ -38,7 +42,7 @@ paths: ...@@ -38,7 +42,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
responses: responses:
"200": "200":
$ref: '#/components/responses/Alarms.Get' $ref: '#/components/responses/Alarms.Get.200'
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -64,17 +68,14 @@ paths: ...@@ -64,17 +68,14 @@ paths:
- $ref: "#/components/parameters/alarmId" - $ref: "#/components/parameters/alarmId"
get: get:
description: > description: >
The client can use this method to read an individual alarm. This method The client can use this method to read an individual alarm. See clause 7.5.4.3.2.
shall follow the provisions specified in the tables 7.5.4.3.2-1 and
7.5.4.3.2-2 for URI query parameters, request and response data
structures, and response codes.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses: responses:
"200": "200":
$ref: '#/components/responses/Alarm.Get' $ref: '#/components/responses/Alarm.Get.200'
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -97,10 +98,7 @@ paths: ...@@ -97,10 +98,7 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/504 $ref: ../components/SOL009_resp.yaml#/components/responses/504
patch: patch:
description: > description: >
This method modifies an "Individual alarm" resource. This method shall This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4.
follow the provisions specified in the tables 7.5.4.3.4-1 and
7.5.4.3.4-2 for URI query parameters, request and response data
structures, and response codes.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
...@@ -110,7 +108,7 @@ paths: ...@@ -110,7 +108,7 @@ paths:
$ref: "#/components/requestBodies/AlarmModifications" $ref: "#/components/requestBodies/AlarmModifications"
responses: responses:
"200": "200":
$ref: '#/components/responses/Alarm.Patch' $ref: '#/components/responses/Alarm.Patch.200'
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -138,24 +136,7 @@ paths: ...@@ -138,24 +136,7 @@ paths:
/subscriptions: /subscriptions:
post: post:
description: > description: >
Subscribe. The POST method creates a new subscription. This method shall The POST method creates a new subscription. See clause 7.5.5.3.1.
follow the provisions specified in the tables 7.5.5.3.1-1 and
7.5.5.3.1-2 for URI query parameters, request and response data
structures, and response codes. As the result of successfully executing
this method, a new "Individual subscription" resource as defined in
clause 7.5.6 shall have been created. This method shall not trigger any
notification. Creation of two "Individual subscription" resources with
the same callbackURI and the same filter can result in performance
degradation and will provide duplicates of notifications to the API
consumer, and might make sense only in very rare use cases.
Consequently, the NFV-MANO functional entity may either allow creating a
new "Individual subscription" resource if another "Individual
subscription" resource with the same filter and callbackUri already
exists (in which case it shall return the "201 Created" response code),
or may decide to not create a duplicate "Individual subscription"
resource (in which case it shall return a "303 See Other" response code
referencing the existing "Individual subscription" resource with the
same filter and callbackUri).
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
...@@ -165,7 +146,7 @@ paths: ...@@ -165,7 +146,7 @@ paths:
$ref: "#/components/requestBodies/FmSubscriptionRequest" $ref: "#/components/requestBodies/FmSubscriptionRequest"
responses: responses:
"201": "201":
$ref: '#/components/responses/subscriptions.post.201' $ref: '#/components/responses/Subscriptions.Post.201'
"303": "303":
$ref: ../components/SOL009_resp.yaml#/components/responses/303 $ref: ../components/SOL009_resp.yaml#/components/responses/303
"400": "400":
...@@ -190,12 +171,9 @@ paths: ...@@ -190,12 +171,9 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/504 $ref: ../components/SOL009_resp.yaml#/components/responses/504
get: get:
description: > description: >
Query Subscription Information
The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. This method alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.
shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters, See clause 7.5.5.3.2.
request and response data structures, and response codes.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
...@@ -204,7 +182,7 @@ paths: ...@@ -204,7 +182,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
responses: responses:
"200": "200":
$ref: '#/components/responses/subscriptions.get.200' $ref: '#/components/responses/Subscriptions.Get.200'
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -230,18 +208,15 @@ paths: ...@@ -230,18 +208,15 @@ paths:
- $ref: "#/components/parameters/subscriptionId" - $ref: "#/components/parameters/subscriptionId"
get: get:
description: > description: >
Query Subscription Information. The client can use this method for The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms
reading an individual subscription for NFV-MANO functional entity alarms subscribed by the client. See clause 7.5.6.3.2.
subscribed by the client. This method shall follow the provisions
specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query
parameters, request and response data structures, and response codes.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses: responses:
"200": "200":
$ref: '#/components/responses/subscription.get.200' $ref: '#/components/responses/Subscription.Get.200'
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -264,22 +239,13 @@ paths: ...@@ -264,22 +239,13 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/504 $ref: ../components/SOL009_resp.yaml#/components/responses/504
delete: delete:
description: > description: >
Terminate Subscription. This method terminates an individual This method terminates an individual subscription. See clause 7.5.6.3.5.
subscription. This method shall follow the provisions specified in the
tables 7.5.6.3.5-1 and 7.5.6.3.5-2 for URI query parameters, request and
response data structures, and response codes. As the result of
successfully executing this method, the "Individual subscription"
resource shall not exist any longer. This means that no notifications
for that subscription shall be sent to the formerly-subscribed API
consumer. NOTE: Due to race conditions, some notifications might still
be received by the formerly-subscribed API consumer for a certain time
period after the deletion.
parameters: parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses: responses:
"204": "204":
$ref: '#/components/responses/subscription.delete.204' $ref: '#/components/responses/Subscription.Delete.204'
"400": "400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400 $ref: ../components/SOL009_resp.yaml#/components/responses/400
"401": "401":
...@@ -417,7 +383,8 @@ components: ...@@ -417,7 +383,8 @@ components:
structure, the following applies: All attributes shall match in order for the filter to match (logical "and" structure, the following applies: All attributes shall match in order for the filter to match (logical "and"
between different filter attributes). If an attribute is an array, the attribute shall match if at least one between different filter attributes). If an attribute is an array, the attribute shall match if at least one
of the values in the array matches (logical "or" between the values of one filter attribute). of the values in the array matches (logical "or" between the values of one filter attribute).
* NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names
of the notification types to facilitate automated code generation systems.
type: object type: object
properties: properties:
notificationTypes: notificationTypes:
...@@ -427,9 +394,8 @@ components: ...@@ -427,9 +394,8 @@ components:
* AlarmNotification * AlarmNotification
* AlarmClearedNotification