Commit 3ee8f80d authored by moscatelli's avatar moscatelli
Browse files

SOL005: fix in OpenAPI versions

parent d11510b3
Pipeline #901 failed with stage
in 0 seconds
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
......
# 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 - 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,8 +25,10 @@ schemes:
consumes:
- application/json
produces:
- application/json
paths:
##################################################################################
# Notification endpoint NS Performance Management #
......@@ -59,145 +61,14 @@ paths:
description: >
Notification about performance information availability.
in: body
required: true
required: false
schema:
$ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/PerformanceInformationAvailableNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
204:
description: >
204 NO CONTENT
The notification was delivered successfully.
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:
$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"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
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.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
The notification endpoint was tested 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:
$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"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/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.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
summary: Notify about PM related events
description: >
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: >
Notification about threshold crossing.
in: body
required: true
required: false
schema:
$ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/ThresholdCrossedNotification"
- name: Accept
......@@ -210,7 +81,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 +142,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
......
......@@ -39,6 +39,7 @@ responses:
minimum: 1
schema:
$ref: "../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
202-with-Location-empty:
description: >
202 ACCEPTED
......@@ -70,8 +71,6 @@ responses:
minimum: 1
206:
description: >
206 PARTIAL CONTENT
headers:
Content-Type:
description: >
......@@ -103,8 +102,6 @@ responses:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
303:
description: >
303 SEE OTHER
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -180,6 +177,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 +208,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 +239,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 +275,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 +304,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 +331,7 @@ 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:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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 any of the following
scenarios:
- Disable a VNF package resource of
hich the operational state is not
ENABLED
- Enable a VNF package resource of
which the operational state is not
DISABLED
The response body shall contain a
ProblemDetails structure, in which the
"detail" attribute shall convey more
information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-another-nsd-operation-ongoing:
description: >
409 CONFLICT
The operation cannot be executed currently, due to a conflict with the
state of the NS instance resource.
Typically, this is due to the fact that another Descriptor operation is
ongoing.
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute should convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-inconsistent-state:
description: >
409 CONFLICT
Another request is in progress that prohibits the fulfilment of
the current request, or the current resource state is inconsistent
with the request.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-state-conflict-INSTANTIATED:
description: >
409 CONFLICT
The operation cannot be executed currently, due to a conflict with the
state of the NS instance resource.
Typically, this is due to the fact that the NS instance resource is in
INSTANTIATED state.
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute should convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-state-conflict-not-FAILED_TEMP:
description: >
409 CONFLICT
The operation cannot be executed currently, due to a conflict with the
state of the NS instance resource.
Typically, this is due to the fact that the NS instance resource is
not in FAILED_TEMP state, or another error handling action is starting,
such as rollback or fail.
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute should convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
409-state-conflict-NOT-INSTANTIATED:
description: >
409 CONFLICT
The operation cannot be executed currently, due to a conflict with the
state of the NS instance resource.
Typically, this is due to the fact that the NS instance resource is in
NOT-INSTANTIATED state, or that another lifecycle management operation
is ongoing.
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute should convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string