Commit 50ff8cac authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

fixed responses data types names

parent 68d7fbac
Pipeline #2263 running with stage
......@@ -165,7 +165,7 @@ paths:
$ref: "#/components/requestBodies/FmSubscriptionRequest"
responses:
"201":
$ref: '#/components/responses/Subscriptions.Post'
$ref: '#/components/responses/subscriptions.post.201'
"303":
$ref: ../components/SOL009_resp.yaml#/components/responses/303
"400":
......@@ -204,7 +204,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
responses:
"200":
$ref: '#/components/responses/Subscriptions.Get'
$ref: '#/components/responses/subscriptions.get.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -241,7 +241,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: '#/components/responses/Subscription.Get'
$ref: '#/components/responses/subscription.get.200'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -279,7 +279,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: '#/components/responses/Subscription.Delete'
$ref: '#/components/responses/subscription.delete.204'
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -569,7 +569,7 @@ components:
schema:
$ref: "#/components/schemas/AlarmModifications"
Subscriptions.Post:
subscriptions.post.201:
description: >
201 CREATED
......@@ -607,7 +607,7 @@ components:
schema:
$ref: "#/components/schemas/FmSubscription"
Subscriptions.Get:
subscriptions.get.200:
description: >
200 OK
......@@ -659,7 +659,7 @@ components:
items:
$ref: "#/components/schemas/FmSubscription"
Subscription.Get:
subscription.get.200:
description: >
200 OK
......@@ -695,7 +695,7 @@ components:
schema:
$ref: "#/components/schemas/FmSubscription"
Subscription.Delete:
subscription.delete.204:
description: >
204 NO CONTENT
......
......@@ -41,7 +41,7 @@ paths:
$ref: "#/components/requestBodies/AlarmNotification"
responses:
"204":
$ref: "#/components/responses/AlarmNotification.post"
$ref: "#/components/responses/AlarmNotification.Post.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -68,7 +68,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/AlarmNotification.get"
$ref: "#/components/responses/AlarmNotification.Get.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -100,7 +100,7 @@ paths:
$ref: "#/components/requestBodies/AlarmClearedNotification"
responses:
"204":
$ref: "#/components/responses/AlarmClearedNotification.post"
$ref: "#/components/responses/AlarmClearedNotification.Post.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -127,7 +127,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/AlarmClearedNotification.get"
$ref: "#/components/responses/AlarmClearedNotification.Get.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -159,7 +159,7 @@ paths:
$ref: "#/components/requestBodies/AlarmListRebuiltNotification"
responses:
"204":
$ref: "#/components/responses/AlarmListRebuiltNotification.post"
$ref: "#/components/responses/AlarmListRebuiltNotification.Post.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -186,7 +186,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/AlarmListRebuiltNotification.get"
$ref: "#/components/responses/AlarmListRebuiltNotification.Get.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
"401":
......@@ -402,7 +402,7 @@ components:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
responses:
AlarmNotification.post:
AlarmNotification.Post.204:
description: >
204 NO CONTENT
......@@ -425,7 +425,7 @@ components:
minimum: 1
maximum: 1
AlarmNotification.get:
AlarmNotification.Get.204:
description: >
204 NO CONTENT
......@@ -449,7 +449,7 @@ components:
minimum: 1
maximum: 1
AlarmClearedNotification.post:
AlarmClearedNotification.Post.204:
description: >
204 NO CONTENT
......@@ -472,7 +472,7 @@ components:
minimum: 1
maximum: 1
AlarmClearedNotification.get:
AlarmClearedNotification.Get.204:
description: >
204 NO CONTENT
......@@ -496,7 +496,7 @@ components:
minimum: 1
maximum: 1
AlarmListRebuiltNotification.post:
AlarmListRebuiltNotification.Post.204:
description: >
204 NO CONTENT
......@@ -519,7 +519,7 @@ components:
minimum: 1
maximum: 1
AlarmListRebuiltNotification.get:
AlarmListRebuiltNotification.Get.204:
description: >
204 NO CONTENT
......
......@@ -304,9 +304,9 @@ paths:
$ref: '#/components/requestBodies/LogmSubscriptionRequest'
responses:
"201":
$ref: '#/components/responses/LogmSubscription.Post.201'
$ref: '#/components/responses/subscriptions.post.201'
"303":
$ref: '#/components/responses/LogmSubscription.Post.303'
$ref: '#/components/responses/subscriptions.post.303'
"422":
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
"400":
......@@ -327,6 +327,9 @@ paths:
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
"504":
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
callbacks:
LogReportAvailableNotification:
$ref: '#/components/callbacks/LogReportAvailableNotification'
get:
description: >-
The API consumer can use this method to query the list of active subscriptions to log management
......@@ -342,7 +345,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: '#/components/responses/LogmSubscriptions.Get.200'
$ref: '#/components/responses/subscriptions.get.200'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -381,7 +384,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: '#/components/responses/LogmSubscription.Get.200'
$ref: '#/components/responses/subscription.get.200'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -416,7 +419,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: '#/components/responses/LogmSubscription.Delete'
$ref: '#/components/responses/subscription.delete.204'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -490,9 +493,16 @@ components:
schema:
$ref: "#/components/schemas/CompileLogRequest"
required: true
LogReportAvailableNotification:
description: >-
Notification about the availability of a log report.
content:
application/json:
schema:
$ref: "#/components/schemas/LogReportAvailableNotification"
responses:
LogmSubscription.Delete:
subscription.delete.204:
description: >-
Shall be returned when the "Individual subscription" resource has been deleted successfully.
The response body shall be empty.
......@@ -514,7 +524,7 @@ components:
schema:
type: string
LogmSubscription.Get.200:
subscription.get.200:
description: >-
Shall be returned when the subscription has been read successfully.
The response body shall contain a representation of the "Individual subscription" resource,
......@@ -541,7 +551,7 @@ components:
schema:
$ref: "#/components/schemas/LogmSubscription"
LogmSubscriptions.Get.200:
subscriptions.get.200:
description: >-
Shall be returned when the list of subscriptions has been queried successfully.
The response body shall contain in an array the representations of all active subscriptions of
......@@ -576,7 +586,7 @@ components:
items:
$ref: "#/components/schemas/LogmSubscription"
LogmSubscription.Post.201:
subscriptions.post.201:
description: >-
Shall be returned when the subscription has been created successfully.
A representation of the created "Individual subscription" resource shall be returned in the response body,
......@@ -610,7 +620,7 @@ components:
schema:
$ref: "#/components/schemas/LogmSubscription"
LogmSubscription.Post.303:
subscriptions.post.303:
description: >-
Shall be returned when a subscription with the same callbackURI and the same filter already exists and the
policy of the NFV-MANO functional entity is to not create redundant subscriptions.
......@@ -926,6 +936,49 @@ components:
type: array
items:
$ref: "#/components/schemas/LoggingJob"
LogReportAvailableNotification.Post:
description: >-
Shall be returned when the notification has been delivered successfully.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
LogReportNotification.Get:
description: >-
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
schemas:
LogmSubscription:
description: >-
......@@ -1605,5 +1658,145 @@ components:
previous CreateLoggingJobRequest issued by the same API consumer, whose public key has not changed.
type: string
LogReportAvailableNotification:
description: >-
This notification informs the receiver that the log report of the NFV-MANO functional entity is available.
It shall comply with the provisions defined in table 8.6.2.4-1.
The notification shall be triggered by the NFV-MANO functional entity when log information has been collected
by the logging job and the log report is available.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- objectInstanceId
- _links
properties:
id:
description: >-
Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions,
the "id" attribute of all these notifications shall have the same value.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
notificationType:
description: >-
Discriminator for the different notification types.
Shall be set to "LogReportAvailableNotification" for this notification type.
type: string
subscriptionId:
description: >-
Identifier of the subscription that this notification relates to.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
timeStamp:
description: >-
Date and time of the generation of the notification.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/DateTime'
objectInstanceId:
description: >-
Identifier that identifies the object instance for which the log report is available.
This attribute shall contain the identifier of the logged object according to their type.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
_links:
description: >-
Links to resources related to this notification.
type: object
required:
- subscription
- logReports
properties:
subscription:
description: >-
Link to the related subscription.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
objectInstance:
description: >-
Link to the resource representing the measured object instance to which the notified change applies.
Shall be present if the measured object instance information is accessible as a resource.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
LoggingJob:
description: >-
Link to the resource that represents the logging job for which the log report is available.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
logReports:
description: >-
Link from which the available log report can be obtained. Due to the relationship of the logging
job compilation and the logging information availability reporting, more than one logReport
notification link can be provided.
type: array
items:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
callbacks:
LogReportAvailableNotification:
'{$request.body#/callbackUri}':
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
subscribed API consumer, which has provided the URI of this resource during the subscription process.
post:
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.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/LogReportAvailableNotification"
responses:
"204":
$ref: '#/components/responses/LogReportAvailableNotification.Post'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
"403":
$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'
"422":
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
"500":
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
"503":
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
"504":
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
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.
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/LogReportNotification.Get'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
"403":
$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'
"422":
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
"500":
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
"503":
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
"504":
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
......@@ -45,7 +45,7 @@ paths:
$ref: "#/components/requestBodies/LogReportAvailableNotification"
responses:
"204":
$ref: '#/components/responses/LogReportAvailableNotification'
$ref: '#/components/responses/notification.post.204'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -79,7 +79,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: '#/components/responses/LogReportNotification.Get'
$ref: '#/components/responses/notification.get.204'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -112,7 +112,7 @@ components:
$ref: "#/components/schemas/LogReportAvailableNotification"
responses:
LogReportAvailableNotification:
notification.post.204:
description: >-
Shall be returned when the notification has been delivered successfully.
headers:
......@@ -133,7 +133,7 @@ components:
schema:
type: string
LogReportNotification.Get:
notification.get.204:
description: >-
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
......
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