Commit 8717bdd9 authored by bernini's avatar bernini

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
......@@ -36,9 +35,9 @@ paths:
resource during the subscription process.
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 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. 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: >
......@@ -298,14 +307,4 @@ components:
required:
- subscription
- objectInstance
- changeStateOpOcc
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
\ No newline at end of file
- changeStateOpOcc
\ 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 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/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
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
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
security:
- OauthSecurity:
- all
externalDocs:
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/callback/v1
- url: https://127.0.0.1/callback/v1
paths:
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification:
/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification:
post:
description: >
The POST method notifies an NFV-MANO functional entity alarm or that the
alarm list has been rebuilt. The API consumer shall have previously
created an "Individual subscription" resource with a matching filter.
This method shall follow the provisions specified in the tables
7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
response data structures, and response codes.
created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
......@@ -59,10 +59,7 @@ paths:
get:
description: >
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 tables 7.5.7.3.2-1 and
7.5.7.3.2-2 for URI query parameters, request and response data
structures, and response codes.
is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
......@@ -83,15 +80,12 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/500
"503":
$ref: ../components/SOL009_resp.yaml#/components/responses/503
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification:
/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification:
post:
description: >
The POST method notifies an NFV-MANO functional entity alarm or that the
alarm list has been rebuilt. The API consumer shall have previously
created an "Individual subscription" resource with a matching filter.
This method shall follow the provisions specified in the tables
7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
response data structures, and response codes.
created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
......@@ -118,10 +112,7 @@ paths:
get:
description: >
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 tables 7.5.7.3.2-1 and
7.5.7.3.2-2 for URI query parameters, request and response data
structures, and response codes.
is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
......@@ -142,15 +133,12 @@ paths:
$ref: ../components/SOL009_resp.yaml#/components/responses/500
"503":
$ref: ../components/SOL009_resp.yaml#/components/responses/503
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification:
/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification:
post:
description: >
The POST method notifies an NFV-MANO functional entity alarm or that the
alarm list has been rebuilt. The API consumer shall have previously
created an "Individual subscription" resource with a matching filter.
This method shall follow the provisions specified in the tables
7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
response data structures, and response codes.
created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
......@@ -177,10 +165,7 @@ paths:
get:
description: >
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 tables 7.5.7.3.2-1 and
7.5.7.3.2-2 for URI query parameters, request and response data
structures, and response codes.
is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
......
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Log Management Notification Operation
description: >
SOL009 - NFV-MANO Log Management Notification Operation
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.
title: SOL009 - NFV-MANO Log Management Notification Interface
description: |
SOL009 - NFV-MANO Log Management Notification Interface
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
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
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
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
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
security:
- OauthSecurity:
- all
externalDocs:
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/callback/v1
- url: https://127.0.0.1/callback/v1
paths:
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification:
/URI_is_provided_by_the_client_when_creating_the_subscription-LogNotification:
description: >-
This resource represents a notification endpoint for NFV-MANO log management.
The API producer can use this resource to send notifications related to log management events to a
......@@ -35,9 +37,7 @@ paths:
description: >-
The POST method delivers a notification regarding a log management event from the API producer to the API
consumer. The API consumer shall have previously created an "Individual subscription" resource with a
matching filter.
This method shall follow the provisions specified in the tables 8.5.9.3.1-1 and 8.5.9.3.1-2 for URI query
parameters, request and response data structures, and response codes.
matching filter. See clause 8.5.9.3.1.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
......@@ -45,7 +45,7 @@ paths:
$ref: "#/components/requestBodies/LogReportAvailableNotification"
responses:
"204":
$ref: '#/components/responses/notification.post.204'
$ref: '#/components/responses/Notification.Post.204'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -70,16 +70,14 @@ paths:
get:
description: >-
The GET method allows the API producer to test the notification endpoint that is provided by the API
consumer, e.g. during subscription.
This method shall follow the provisions specified in the tables 8.5.9.3.2-1 and 8.5.9.3.2-2 for URI
query parameters, request and response data structures, and response codes.
consumer, e.g. during subscription. See clause 8.5.9.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":
......@@ -110,9 +108,10 @@ components:
application/json:
schema:
$ref: "#/components/schemas/LogReportAvailableNotification"
required: true
responses:
notification.post.204:
Notification.Post.204:
description: >-
Shall be returned when the notification has been delivered successfully.
headers:
......@@ -133,7 +132,7 @@ components:
schema:
type: string
notification.get.204:
Notification.Get.204:
description: >-
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
......
......@@ -18,7 +18,6 @@ endpoints:
schema:
type: string
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
......@@ -65,8 +64,6 @@ endpoints:
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
404:
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
405:
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
406:
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
413:
......@@ -84,4 +81,32 @@ endpoints:
503:
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
504:
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
\ No newline at end of file
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
post:
description: >
This method is not supported. When this method is requested on this resource, the API producer shall return a "405
Method Not Allowed" response as defined in SOL013 clause 6.4.
responses:
405:
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
put:
description: >
This method is not supported. When this method is requested on this resource, the API producer shall return a "405
Method Not Allowed" response as defined in SOL013 clause 6.4.
responses:
405:
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
patch:
description: >
This method is not supported. When this method is requested on this resource, the API producer shall return a "405
Method Not Allowed" response as defined in SOL013 clause 6.4.
responses:
405:
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
delete:
description: >
This method is not supported. When this method is requested on this resource, the API producer shall return a "405
Method Not Allowed" response as defined in SOL013 clause 6.4.
responses:
405:
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment