Commit 14c66f2f authored by moscatelli's avatar moscatelli
Browse files

SOL002: VNF Indicator notification interface data types consolidation

parent 6001fb66
Pipeline #897 passed with stage
in 0 seconds
...@@ -31,7 +31,10 @@ produces: ...@@ -31,7 +31,10 @@ produces:
- application/json - application/json
paths: paths:
/notificationendpoint: ###############################################################################
# Notification endpoint #
###############################################################################
'/URI-is-provided-by-the-client-when-creating-the-subscription':
parameters: parameters:
- name: Version - name: Version
description: > description: >
...@@ -39,6 +42,13 @@ paths: ...@@ -39,6 +42,13 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
post: post:
summary: Notification endpoint summary: Notification endpoint
description: > description: >
...@@ -53,7 +63,7 @@ paths: ...@@ -53,7 +63,7 @@ paths:
A notification about VNF indicator value changes. A notification about VNF indicator value changes.
required: true required: true
schema: schema:
$ref: 'definitions/VnfIndicatorValueChangeNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'
responses: responses:
204: 204:
description: > description: >
...@@ -66,18 +76,20 @@ paths: ...@@ -66,18 +76,20 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
400:
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 401:
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 403:
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 405:
409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 406:
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 500:
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get: get:
summary: Test notification endpoint. summary: Test notification endpoint.
description: > description: >
...@@ -88,23 +100,34 @@ paths: ...@@ -88,23 +100,34 @@ paths:
responses: responses:
204: 204:
description: > description: >
No Content 204 NO CONTENT
The notification endpoint was tested successfully. The response body shall be empty. The notification endpoint was tested successfully. The response body shall be empty.
headers: 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.
type: string
maximum: 1
minimum: 0
Version: Version:
description: The used API version. description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 400:
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 401:
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 403:
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } 405:
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 406:
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } 500:
\ No newline at end of file $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
\ No newline at end of file
definitions: # Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
VnfIndicatorValueChangeNotification: VnfIndicatorValueChangeNotification:
description: > description: >
This type represents a VNF indicator value change notification. This type represents a VNF indicator value change notification.
......
responses:
409:
description: >
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
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
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