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
This repository contains OpenAPIs for ETSI GS NFV-SOL 009, RESTful protocols
specification for the management of NFV-MANO.
This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v3.5.1, RESTful protocols
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).
......
openapi: 3.0.2
info:
version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - API version interface
description: >
description: |
SOL009 - API version Interface
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 approved by the ETSI NFV ISG. In case of
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/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
contact:
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:
description: ETSI GS NFV-SOL 009 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
description: ETSI GS NFV-SOL 009 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
paths:
/nfvmanocim/api_versions:
......
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Configuration and Information Management Notification Operation
description: >
SOL009 - NFV-MANO Configuration and Information Management Notification Operation
title: SOL009 - NFV-MANO Configuration and Information Management Notification Interface
description: |
SOL009 - NFV-MANO Configuration and Information Management Notification Interface
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
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
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
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: NFV-SOL WG
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
description: ETSI GS NFV-SOL 009 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
servers:
- url: http://0.0.0.0/callback/v1
description: >
API HTTP Server
- url: https://0.0.0.0/callback/v1
description: >
API HTTPS Server
- url: http://127.0.0.1/callback/v2
- url: https://127.0.0.1/callback/v2
paths:
/URI-is-provided-by-the-client-when-creating-the-subscription-ConfigurationAndInformationNotification:
/URI_is_provided_by_the_client_when_creating_the_subscription-ConfigurationAndInformationNotification:
description: >
This resource represents a notification endpoint. The API producer can use this
resource to send notifications related to NFV-MANO configuration and information
......@@ -37,8 +36,8 @@ paths:
post:
description: >
The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription"
resource with a matching filter.
The API consumer shall have previously created an "Individual subscription" resource
with a matching filter. See clause 5.5.6.3.1.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
......@@ -47,7 +46,7 @@ paths:
$ref: "#/components/requestBodies/ConfigurationAnfInformationNotification"
responses:
"204":
$ref: "#/components/responses/notification.post.204"
$ref: "#/components/responses/Notification.Post.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -72,14 +71,14 @@ paths:
get:
description: >
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:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/notification.get.204"
$ref: "#/components/responses/Notification.Get.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -103,7 +102,7 @@ paths:
components:
responses:
notification.post.204:
Notification.Post.204:
description: >
204 NO CONTENT
......@@ -122,7 +121,7 @@ components:
schema:
type: string
notification.get.204:
Notification.Get.204:
description: >
204 NO CONTENT
......@@ -165,6 +164,15 @@ components:
configuration and information of the NFV-MANO functional entity
have been changed.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
properties:
id:
description: >
......@@ -213,20 +221,21 @@ components:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- self
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
ChangeStateNotification:
description: >
This type represents a Change state operation occurrence.
type: object
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
properties:
id:
description: >
......@@ -299,13 +308,3 @@ components:
- subscription
- objectInstance
- changeStateOpOcc
\ No newline at end of file
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
\ No newline at end of file
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Fault Management interface
description: >
description: |
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:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
description: ETSI GS NFV-SOL 009 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
servers:
- url: http://127.0.0.1/nfvmanofm/v1
......@@ -26,10 +33,7 @@ paths:
/alarms:
get:
description: >
Get Alarm List. The client can use this method to retrieve information
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.
The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
......@@ -38,7 +42,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
responses:
"200":
$ref: '#/components/responses/Alarms.Get'
$ref: '#/components/responses/Alarms.Get.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -64,17 +68,14 @@ paths:
- $ref: "#/components/parameters/alarmId"
get:
description: >
The client can use this method to read an individual alarm. This method
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.
The client can use this method to read an individual alarm. See clause 7.5.4.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: '#/components/responses/Alarm.Get'
$ref: '#/components/responses/Alarm.Get.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -97,10 +98,7 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/504
patch:
description: >
This method modifies an "Individual alarm" resource. This method shall
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.
This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
......@@ -110,7 +108,7 @@ paths:
$ref: "#/components/requestBodies/AlarmModifications"
responses:
"200":
$ref: '#/components/responses/Alarm.Patch'
$ref: '#/components/responses/Alarm.Patch.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -138,24 +136,7 @@ paths:
/subscriptions:
post:
description: >
Subscribe. The POST method creates a new subscription. This method shall
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).
The POST method creates a new subscription. See clause 7.5.5.3.1.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
......@@ -165,7 +146,7 @@ paths:
$ref: "#/components/requestBodies/FmSubscriptionRequest"
responses:
"201":
$ref: '#/components/responses/subscriptions.post.201'
$ref: '#/components/responses/Subscriptions.Post.201'
"303":
$ref: ../components/SOL009_resp.yaml#/components/responses/303
"400":
......@@ -190,12 +171,9 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
Query Subscription Information
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
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,
request and response data structures, and response codes.
alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.
See clause 7.5.5.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
......@@ -204,7 +182,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
responses:
"200":
$ref: '#/components/responses/subscriptions.get.200'
$ref: '#/components/responses/Subscriptions.Get.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -230,18 +208,15 @@ paths:
- $ref: "#/components/parameters/subscriptionId"
get:
description: >
Query Subscription Information. The client can use this method for
reading an individual subscription for NFV-MANO functional entity alarms
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.
The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms
subscribed by the client. See clause 7.5.6.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: '#/components/responses/subscription.get.200'
$ref: '#/components/responses/Subscription.Get.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -264,22 +239,13 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/504
delete:
description: >
Terminate Subscription. This method terminates an individual
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.
This method terminates an individual subscription. See clause 7.5.6.3.5.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: '#/components/responses/subscription.delete.204'
$ref: '#/components/responses/Subscription.Delete.204'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -417,7 +383,8 @@ components:
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
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
properties:
notificationTypes:
......@@ -427,9 +394,8 @@ components:
* AlarmNotification
* AlarmClearedNotification
* AlarmListRebuiltNotification
The permitted values of the "notificationTypes" attribute are
spelled exactly as the names of the notification types to
facilitate automated code generation systems.
See note.
type: array
items:
type: string
......@@ -478,7 +444,7 @@ components:
required: true
responses:
Alarms.Get:
Alarms.Get.200:
description: >
200 OK
......@@ -520,7 +486,7 @@ components:
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"
Alarm.Get:
Alarm.Get.200:
description: >
200 OK
......@@ -540,7 +506,7 @@ components:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"
Alarm.Patch:
Alarm.Patch.200:
description: >
200 OK
......@@ -569,7 +535,7 @@ components:
schema:
$ref: "#/components/schemas/AlarmModifications"
subscriptions.post.201:
Subscriptions.Post.201:
description: >
201 CREATED
......@@ -606,8 +572,78 @@ components:
application/json:
schema:
$ref: "#/components/schemas/FmSubscription"
Subscriptions.Post.303:
description: >
303 SEE OTHER
Shall be returned when a subscription with the same
callbackURI and the same filter already exists and the
policy of NFV-MANO functional entity is to not create
redundant subscriptions.
The HTTP response shall include a "Location" HTTP header
that contains the resource URI of the existing "Individual
subscription" resource.
The response body shall be empty.
headers:
WWW-Authenticate:
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual subscription" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
Subscriptions.Post.422:
description: >
422 Unprocessable Entity
Shall be returned upon the following error: The content type
of the payload body is supported and the payload body of a request
contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in
clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
of the response body.
Specifically in case of this resource, the response code 422 shall also
be returned if the API producer has tested the Notification endpoint as
described in clause 7.5.7.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure
shall convey more information about the error.
headers:
WWW-Authenticate:
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
subscriptions.get.200:
Subscriptions.Get.200:
description: >
200 OK
......@@ -659,7 +695,7 @@ components:
items:
$ref: "#/components/schemas/FmSubscription"
subscription.get.200:
Subscription.Get.200:
description: >
200 OK
......@@ -695,7 +731,7 @@ components:
schema:
$ref: "#/components/schemas/FmSubscription"
subscription.delete.204:
Subscription.Delete.204:
description: >
204 NO CONTENT
......
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Fault Management Notification Operation
description: >
SOL009 - NFV-MANO Fault Management Notification Operation
title: SOL009 - NFV-MANO Fault Management Notification Interface
description: |
SOL009 - NFV-MANO Fault Management Notification 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/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs: