Commit fa630c42 authored by Samir Medjiah's avatar Samir Medjiah
Browse files

Fix common data types

parents 8c64da22 46e3a7d3
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - API version interface"
description: >
SOL005 - API version Interface
......@@ -14,16 +15,21 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
paths:
###############################################################################
# API Versions #
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NSD Management Interface"
description: >
SOL005 - NSD Management Interface
......@@ -15,17 +15,23 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: /nsd/v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
paths:
###############################################################################
# API Versions #
......@@ -408,6 +414,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
description: >
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
Typically, this is due to an operational state mismatch, i.e. enable an already enabled or disable
an already disabled individual NS descriptor resource, or the "nsdOnboardingState" is not ONBOARDED.
......@@ -445,7 +453,7 @@ paths:
responses:
204:
description: >
204 No Content
204 NO CONTENT
The operation has completed successfully.
The response body shall be empty.
......@@ -478,6 +486,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
description: >
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact the NS descriptor resource is in the enabled operational state
(i.e. operationalState = ENABLED) or there are running NS instances using the concerned individual
......@@ -589,6 +599,8 @@ paths:
minimum: 1
206:
description: >
206 PARTIAL CONTENT
On success, if the NFVO supports range requests, a single consecutive byte range from the content
of the NSD file is returned.
The response body shall contain the requested part of the NSD file.
......@@ -609,6 +621,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
description: >
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact "nsdOnboardingState" has a value different from ONBOARDED.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
......@@ -616,6 +630,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
description: >
416 RANGE NOT SATISFIABLE
The byte range passed in the "Range" header did not match any available byte range in the NSD file
(e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
......@@ -694,6 +710,21 @@ paths:
The NSD content was successfully uploaded and validated (synchronous mode).
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -708,6 +739,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
description: >
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact that the NsdOnboardingState has a value other than CREATED.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
......@@ -1116,6 +1149,21 @@ paths:
The operation has completed successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -1217,6 +1265,8 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
description: >
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact pnfdOnboardingState has a value different from ONBOARDED.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute
......@@ -1249,6 +1299,21 @@ paths:
The PNFD content was successfully uploaded and validated.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -1263,8 +1328,9 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
description: >
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact that the PnfdOnboardingState has a value other than CREATED.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
......@@ -1370,6 +1436,8 @@ paths:
minimum: 1
303:
description: >
303 SEE OTHER
A subscription with the same callbackURI and the same filter already exits and the policy of the NFVO
is to not create redundant subscriptions.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
......@@ -1617,6 +1685,21 @@ paths:
The subscription resource was deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
NsdInfoModifications:
type: object
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL005 - NSD Management Notification interface
description: >
SOL005 - NSD Management Notification interface
......@@ -30,9 +30,9 @@ produces:
paths:
###############################################################################
# Notification endpoint NSDManagement #
# Notification endpoint NsdOnBoardingNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingNotification':
'/URI_is_provided_by_the_client_when_creating_the_subscription_NsdOnBoardingNotification':
parameters:
- name: Authorization
description: >
......@@ -177,8 +177,10 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingFailureNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
###############################################################################
# Notification endpoint NsdOnBoardingFailureNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_NsdOnBoardingFailureNotification':
parameters:
- name: Authorization
description: >
......@@ -323,8 +325,10 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdChangeNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
###############################################################################
# Notification endpoint NsdChangeNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_NsdChangeNotification':
parameters:
- name: Authorization
description: >
......@@ -469,8 +473,10 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdDeletionNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
###############################################################################
# Notification endpoint NsdDeletionNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_NsdDeletionNotification':
parameters:
- name: Authorization
description: >
......@@ -615,8 +621,10 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
###############################################################################
# Notification endpoint PnfdOnBoardingNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_PnfdOnBoardingNotification':
parameters:
- name: Authorization
description: >
......@@ -668,7 +676,7 @@ paths:
responses:
204:
description: >
204 No Content
204 NO CONTENT
The notification was delivered successfully.
headers:
......@@ -761,8 +769,10 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingFailureNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
###############################################################################
# Notification endpoint PnfdOnBoardingFailureNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_PnfdOnBoardingFailureNotification':
parameters:
- name: Authorization
description: >
......@@ -907,8 +917,10 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdDeletionNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
###############################################################################
# Notification endpoint PnfdDeletionNotification #
###############################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_PnfdDeletionNotification':
parameters:
- name: Authorization
description: >
......@@ -960,7 +972,7 @@ paths:
responses:
204:
description: >
204 No Content
204 NO CONTENT
The notification was delivered successfully.
headers:
......@@ -1051,4 +1063,4 @@ paths:
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
\ No newline at end of file
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Fault Management Interface"
description: >
SOL005 - NS Fault Management Interface
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Fault Management Notification interface"
description: >
SOL005 - NS Fault Management Notification interface
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Lifecycle Management Interface"
description: >
SOL005 - NS Lifecycle Management Interface
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Lifecycle Management Notification interface"
description: >
SOL005 - NS Lifecycle Management Notification interface
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Performance Management Interface"
description: >
SOL005 - NS Performance Management Interface
......@@ -15,17 +15,23 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: /nspm/v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
paths:
###############################################################################
# API Versions #
......@@ -771,7 +777,7 @@ paths:
responses:
204:
description: >
204 No Content
204 NO CONTENT
The threshold was deleted successfully.
The response body shall be empty.
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
PmSubscriptionRequest:
description: >
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Performance Management Notification interface"
description: >
SOL005 - NS Performance Management Notification interface
......@@ -25,13 +25,15 @@ schemes:
consumes:
- application/json
produces:
- application/json
paths:
##################################################################################
# Notification endpoint NS Performance Management #
# Notification endpoint PerformanceInformationAvailableNotification #
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-PerformanceInformationAvailableNotification':
'/URI_is_provided_by_the_client_when_creating_the_subscription_PerformanceInformationAvailableNotificatio':
parameters:
- name: Authorization
description: >
......@@ -53,7 +55,6 @@ paths:
The POST method delivers a notification regarding a performance management event from the server to the client.
This method shall follow the provisions specified in the
Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters,
parameters:
- name: PerformanceInformationAvailableNotification
description: >
......@@ -133,7 +134,7 @@ paths:
responses:
204:
description: >
204 No Content
204 NO CONTENT
The notification endpoint was tested successfully.
The response body shall be empty.
......@@ -169,12 +170,15 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-ThresholdCrossedNotification':
##################################################################################
# Notification endpoint ThresholdCrossedNotification #
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription_ThresholdCrossedNotification':
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
Reference: IETF RFC 7235
in: header
required: false
type: string
......@@ -191,7 +195,6 @@ paths:
The POST method delivers a notification regarding a performance management event from the server to the client.
This method shall follow the provisions specified in the
Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters,
parameters:
- name: ThresholdCrossedNotification
description: >
......@@ -210,7 +213,7 @@ paths:
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
Reference: IETF RFC 7231
in: header
required: true
type: string
......@@ -271,7 +274,7 @@ paths:
responses:
204:
description: >
204 No Content
204 NO CONTENT
The notification endpoint was tested successfully.
The response body shall be empty.
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL005 - VNF Package Management Interface
description: >
SOL005 - VNF Package Management Interface
......
swagger: "2.0"
info:
version: "1.1.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - VNF Package Management Notification interface"
description: >
SOL005 - VNF Package Management Notification interface
......
......@@ -38,7 +38,8 @@ responses:
maximum: 1
minimum: 1
schema:
$ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
$ref: "../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
202-with-Location-empty:
description: >
202 ACCEPTED
......@@ -180,6 +181,7 @@ responses:
401:
description: >
401 UNAUTHORIZED
If the request contains no access token even though one is required, or if the request contains an authorization
token that is invalid (e.g. expired or revoked), the API producer should respond with this response.
The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750
......@@ -210,6 +212,7 @@ responses:
403:
description: >
403 FORBIDDEN
If the API consumer is not allowed to perform a particular request to a particular resource,
the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided.
It should include in the "detail" attribute information about the source of the problem,
......@@ -240,6 +243,7 @@ responses:
404:
description: >
404 NOT FOUND
If the API producer did not find a current representation for the resource addressed by the URI passed
in the request or is not willing to disclose that one exists, it shall respond with this response code.
The "ProblemDetails" structure may be provided, including in the "detail" attribute information about
......@@ -275,6 +279,7 @@ responses:
405:
description: >
405 METHOD NOT ALLOWED
If a particular HTTP method is not supported for a particular resource, the API producer shall respond
with this response code. The "ProblemDetails" structure may be omitted.
headers:
......@@ -303,6 +308,7 @@ responses:
406:
description: >
406 NOT ACCEPTABLE
If the "Accept" header does not contain at least one name of a content type that is acceptable
to the API producer, the API producer shall respond with this response code.
The "ProblemDetails" structure may be omitted.
......@@ -329,284 +335,9 @@ responses:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
406-state-conflict:
description: >
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that
"onboardingState" of the VNF package has a value
different from "ONBOARDED".
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
Content-Type: