Commit a1b6ad3a authored by f.moscatelli's avatar f.moscatelli

APIVersion Ns LCM Notification interfaces migrated to OpenAPI 3.0.2

parent d1fac1c4
Pipeline #3640 failed with stage
in 0 seconds
swagger: "2.0"
openapi: 3.0.2
info:
version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - API version interface"
description: >
SOL005 - 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 discrepancies the published ETSI
Group Specification takes precedence.
title: SOL005 - API version interface
description: |
SOL005 - 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 discrepancies the
published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license:
name: "ETSI Forge copyright notice"
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 005 V2.7.1
description: ETSI GS NFV-SOL 005 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
servers:
- url: http://127.0.0.1/
- url: https://127.0.0.1/
paths:
###############################################################################
# API Versions #
###############################################################################
'/nsd/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/nsd/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
'/nsfm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/nsfm/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
'/nslcm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/nslcm/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
'/nspm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/nspm/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
'/vnfpkgm/api_versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
\ No newline at end of file
/vnfpkgm/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
\ No newline at end of file
This diff is collapsed.
......@@ -95,15 +95,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint.
description: >
......@@ -153,21 +153,21 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
#ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.6
......@@ -233,15 +233,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint.
description: >
......@@ -291,21 +291,21 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
post:
......@@ -370,15 +370,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint.
description: >
......@@ -428,18 +428,18 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
\ No newline at end of file
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
\ No newline at end of file
......@@ -102,21 +102,21 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint
......@@ -159,21 +159,21 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
##################################################################################
# Notification endpoint ThresholdCrossedNotification #
......@@ -247,21 +247,21 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint
......@@ -304,18 +304,18 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
\ No newline at end of file
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
\ No newline at end of file
......@@ -89,15 +89,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint.
......@@ -148,21 +148,21 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification':
post:
......@@ -230,15 +230,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint
......@@ -274,12 +274,12 @@ paths:
The notification endpoint was tested successfully.
The response body shall be empty.
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
\ No newline at end of file
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
\ No newline at end of file
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
endpoints:
api-versions:
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
get:
summary: Retrieve API version information
description: >
......@@ -16,35 +12,60 @@ endpoints:
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
responses:
200:
description: >
API version information was read successfully.
The response body shall contain 4.4 API version
information, as defined in clause 4.4.1.13.
"200":
$ref: '#/components/responses/ApiVersions.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"413":
$ref: ../responses/SOL005_resp.yaml#/components/responses/413
"414":
$ref: ../responses/SOL005_resp.yaml#/components/responses/414
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"422":
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
"429":
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
components:
responses:
ApiVersions.Get:
description: >
200 OK
API version information was read successfully.
The response body shall contain 4.4 API version
information, as defined in clause 4.4.1.13.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
schema:
type: string
maximum: 1
minimum: 1
content:
application/json:
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
\ No newline at end of file
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
\ No newline at end of file
This diff is collapsed.
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