From 35f30f0ac3730b48f15b6709922a1997c3d7c1f2 Mon Sep 17 00:00:00 2001 From: rameshnaraya Date: Fri, 7 Dec 2018 15:23:50 +0100 Subject: [PATCH] Merge Request issue. Re committing NSPM files. --- .../NSperformanceManagement.yaml | 663 +++++++++++------- .../NSPerfomananceManagement_def.yaml | 36 +- .../SOL005NSPerfomananceManagement_def.yaml | 12 +- .../definitions/SOL005_def.yaml | 8 +- .../responses/SOL005_resp.yaml | 4 +- 5 files changed, 423 insertions(+), 300 deletions(-) diff --git a/src/SOL005/NSPerformanceManagement/NSperformanceManagement.yaml b/src/SOL005/NSPerformanceManagement/NSperformanceManagement.yaml index ebe5e68..8ab7e69 100644 --- a/src/SOL005/NSPerformanceManagement/NSperformanceManagement.yaml +++ b/src/SOL005/NSPerformanceManagement/NSperformanceManagement.yaml @@ -2,9 +2,9 @@ swagger: "2.0" info: version: "2.4.1" - title: DRAFT - SOL005 - NS Performance Management Interface + title: SOL005 - NS Performance Management Interface description: > - DRAFT - SOL005 - NS Performance Management Interface + SOL005 - NS Performance Management 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 @@ -36,55 +36,78 @@ paths: '/pm_jobs': #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2 post: - summary: "PM Jobs" + summary: Create a PM job. description: > - "This resource represents PM jobs. The client can use this resource to create and query PM jobs. - The POST method creates a PM job. This method shall follow the provisions specified in the - Tables 7.4.2.3.1-1 and 7.4.2.3.1-2 for URI query parameters, - request and response data structures, and response codes." + This resource represents PM jobs. + The client can use this resource to create and query PM jobs. parameters: - - name: CreatePmJobRequest - description: "The NS Instance creation parameters." - in: body - required: true - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/CreatePmJobRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Content-Type + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + 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 + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "CreatePmJobRequest" + properties: + CreatePmJobRequest: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/CreatePmJobRequest" description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - in: header - required: true - type: string - responses: + PM job creation request. + responses: 201: - description: > - "201 Created." - - "The PM job was created successfully. - The response body shall contain a representation of - the created PM job resource, as defined in - clause 7.5.2.7. - The HTTP response shall include a "Location" HTTP - header that points to the created PM job resource." + description: "Status 201" schema: + type: "object" description: > - "Information of the selected VNF packages." - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob" + 201 Created. + + The PM job was created successfully. + The response body shall contain a representation of + the created PM job resource, as defined in clause 7.5.2.7. + The HTTP response shall include a "Location" HTTP + header that points to the created PM job resource. + properties: + PmJob: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob" + headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. + 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. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -105,7 +128,7 @@ paths: $ref: "responses/SOL005_resp.yaml#/responses/503" get: - summary: "PM Jobs" + summary: Query PM jobs. description: > "The client can use this method to retrieve information about PM jobs" parameters: @@ -173,23 +196,33 @@ paths: required: true type: string responses: - 201: - description: > - "201 OK." + 200: + description: > + 200 OK. - "Information about zero or more PM jobs was queried successfully. + Information about zero or more PM jobs was queried successfully. The response body shall contain representations of - zero or more PM jobs, as defined in clause 7.5.2.7." - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob" + zero or more PM jobs, as defined in clause 7.5.2.7 headers: - Location: - type: "string" - description: > - "The HTTP response shall include a "Location" HTTP header - that contains the resource URI of the new NS descriptor resource." + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + 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. + schema: + type: array + items: + properties: + PmJob: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob" 400: - $ref: "responses/SOL005_resp.yaml#/responses/400-attr-based-filtering-error" + $ref: "responses/SOL005_resp.yaml#/responses/400" 401: $ref: "responses/SOL005_resp.yaml#/responses/401" 403: @@ -212,11 +245,14 @@ paths: - name: pmJobId description: > Identifier of the PM job. + This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response + to a POST request creating a new PM job resource. It can also be retrieved from the "id" attribute in the + payload body of that response. in: path type: string required: true get: - summary: Individual PM job + summary: Read a single PM job. description: > The client can use this method for reading an individual PM job. parameters: @@ -236,23 +272,33 @@ paths: type: string responses: 200: - description: > - 200 OK. - - Information about an individual PM job was queried successfully. - The response body shall contain a representation of the PM job - resource. + description: 200 OK. + schema: + type: "object" + description: > + Information about an individual PM job was queried successfully. + The response body shall contain a representation of + the PM job resource, as defined in clause 7.5.2.7. + properties: + PmJob: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message body. 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. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -268,7 +314,7 @@ paths: 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: - summary: Individual PM job + summary: Delete a PM job. description: > This method terminates an individual PM job. parameters: @@ -329,7 +375,7 @@ paths: type: string required: true get: - summary: Individual performance report + summary: Read an individual performance report. description: > The client can use this method for reading an individual performance report. @@ -350,22 +396,34 @@ paths: type: string responses: 200: - description: > - Information of an individual performance report was read - successfully. - The response body shall contain a representation of the - performance report resource. + description: 200 OK. + schema: + type: "object" + description: > + Information about the individual NS descriptor. + The response body shall contain a representation of + the individual NS descriptor, as defined in + clause 5.5.2.2. + properties: + PerformanceReport: + $ref: "definitions/NSPerfomananceManagement_def.yaml#/definitions/PerformanceReport" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message body. 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. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "definitions/NSPerfomananceManagement_def.yaml#/definitions/PerformanceReport" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -387,67 +445,78 @@ paths: '/thresholds': #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.5 post: - summary: Thresholds + summary: Create a threshold. description: > This resource represents thresholds. The client can use this resource to create and query thresholds. The POST method can be used by the client to create a threshold parameters: - - name: CreateThresholdRequest + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + 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 + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "CreateThresholdRequest" + properties: + CreateThresholdRequest: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/CreateThresholdRequest" description: > Request parameters to create a threshold resource. - in: body - required: true - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/CreateThresholdRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - 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: 201: - description: > - 201 - Created. - - A threshold was created successfully. - The response body shall contain a representation of - the created threshold resource, as defined in - clause 7.5.2.9. - The HTTP response shall include a "Location" HTTP - header that contains the resource URI of the created - threshold resource. + description: 201 - Created. + schema: + type: "object" + description: > + A threshold was created successfully. + The response body shall contain a representation of + the created threshold resource, as defined in clause 7.5.2.9. + The HTTP response shall include a "Location" HTTP + header that contains the resource URI of the created + threshold resource. + properties: + Threshold: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/Threshold" headers: Location: - description: The resource URI of the created threshold instance - type: string - format: url + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. 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. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/Threshold" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -463,7 +532,7 @@ paths: 503: $ref: "responses/SOL005_resp.yaml#/responses/503" get: - summary: Thresholds + summary: Query thresholds. description: > The client can use this method to query information about thresholds. parameters: @@ -472,11 +541,11 @@ paths: required: false type: "string" description: > - "Attribute-based filtering parameters according to clause 4.3.2. + Attribute-based filtering parameters according to clause 4.3.2. The NFVO shall support receiving filtering parameters as part of the URI query string. The OSS/BSS may supply filtering parameters. All attribute names that appear in the Thresholds data type and in data types - referenced from it shall be supported in attribute-based filtering parameters." + referenced from it shall be supported in attribute-based filtering parameters. - name: Accept description: > Content-Types that are acceptable for the response. @@ -491,32 +560,33 @@ paths: in: header required: true type: string + responses: 200: - description: > + description: > 200 - OK. - Information about zero or more thresholds was queried - successfully. + Information about zero or more thresholds was queried successfully. The response body shall contain representations of - zero or more thresholds, as defined in clause 7.5.2.9 + zero or more thresholds, as defined in clause 7.5.2.9. headers: - Location: - description: The resource URI of the created threshold instance + Content-Type: + description: The MIME type of the body of the response. type: string - format: url + maximum: 1 + minimum: 1 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. - type: string - maximum: 1 - minimum: 0 + request has provided an invalid authorization token. schema: type: array - items: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/Threshold" + items: + properties: + Threshold: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/Threshold" 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -549,10 +619,12 @@ paths: type: string required: true get: - summary: Individual threshold + summary: Query a single threshold. description: > - This resource represents an individual threshold. The client can use this method for reading an individual threshold. + This method shall follow the provisions specified in the + Tables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters, + request and response data structures, and response codes. parameters: - name: Accept description: > @@ -570,21 +642,33 @@ paths: type: string responses: 200: - description: > - Information about an individual threshold was queried - successfully. The response body shall contain a - representation of the threshold. + description: 200 OK. + schema: + type: "object" + description: > + Information about an individual threshold was queried successfully. + The response body shall contain a representation of + the threshold, as defined in clause 7.5.2.9. + properties: + Threshold: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/Threshold" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message body. 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. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/Threshold" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -600,7 +684,7 @@ paths: 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: - summary: Individual threshold + summary: Delete a threshold. description: > This resource represents an individual threshold. This method allows to delete a threshold. @@ -654,71 +738,87 @@ paths: '/subscriptions': #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.7 post: - summary: Subscriptions + summary: Subscribe to PM notifications. description: > The POST method creates a new subscription. This method shall follow the provisions specified in the Tables 7.4.7.3.1-1 and 7.4.7.3.1-2 for URI query parameters, request and response data structures, and response codes. - Creation of two subscription resources with the same callbackURI and - the same filter can result in performance degradation and will provide - duplicates of notifications to the OSS, and might make sense only in very rare use cases. + Creation of two subscription resources with the same callbackURI and the same filter can result in performance + degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the - same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), - or may decide to not create a duplicate subscription resource (in which case it shall return - a "303 See Other" response code referencing the existing subscription resource with the same filter and callbackUri). + same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide + to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing + the existing subscription resource with the same filter and callbackUri) parameters: - - name: PmSubscriptionRequest - description: > - Details of the subscription to be created. - in: body - required: true - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscriptionRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string - - name: Content-Type + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + 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 + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "PmSubscriptionRequest" + properties: + PmSubscriptionRequest: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscriptionRequest" description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - in: header - required: true - type: string + Details of the subscription to be created. responses: 201: - description: > - 201 Created. - The subscription was created successfully. - A representation of the - created subscription resource shall be returned in the response body. - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the created subscription resource. + description: 201 Created. + schema: + type: "object" + description: > + The subscription was created successfully. + A representation of the created subscription resource + shall be returned in the response body, as defined in clause 7.5.2.3. + The HTTP response shall include a "Location" HTTP + header that contains the resource URI of the created subscription resource. + properties: + PmSubscription: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription" headers: Location: - description: The resource URI of the created VNF instance - type: string - format: url + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. + maximum: 1 + minimum: 1 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. - type: string + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. maximum: 1 - minimum: 0 - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription" + minimum: 0 303: $ref: "responses/SOL005_resp.yaml#/responses/303" 400: @@ -736,23 +836,24 @@ paths: 503: $ref: "responses/SOL005_resp.yaml#/responses/503" get: - summary: Subscriptions + summary: Query PM related subscriptions. description: > - The client can use this method to query the list of active - subscriptions to Performance management notifications subscribed by - the client. + The client can use this method to query the list of active subscriptions to Performance management notifications + subscribed by the client. + This method shall follow the provisions specified in the Tables 7.4.7.3.2-1 and 7.4.7.3.2-2 for URI query parameters, + request and response data structures, and response codes. parameters: - name: "filter" in: "query" required: false type: "string" description: > - "Attribute-based filtering parameters according to clause 4.3.2. + Attribute-based filtering parameters according to clause 4.3.2. The NFVO shall support receiving filtering parameters as part of the URI query string. The OSS/BSS may supply filtering parameters. All attribute names that appear in the PmSubscription and in data types referenced from it shall be supported in attribute-based filtering - parameters." + parameters. - name: Accept description: > Content-Types that are acceptable for the response. @@ -769,30 +870,31 @@ paths: type: string responses: 200: - description: > + description: > + 200 OK. + The list of subscriptions was queried successfully. - The response body shall contain the representations of all active - subscriptions of the functional block that invokes the method. + The response body shall contain the representations of + all active subscriptions of the functional block that + invokes the method, as defined in clause 7.5.2.3. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. - type: string - maximum: 1 - minimum: 0 + request has provided an invalid authorization token. schema: type: array - items: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription" + items: + properties: + PmSubscription: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription" 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -815,21 +917,20 @@ paths: parameters: - name: subscriptionId description: > - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new subscription resource. It can also be retrieved from the "id" - attribute in the payload body of that response. + Identifier of the subscription. + This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response + to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the + payload body of that response. in: path type: string required: true get: - summary: Individual subscription + summary: Query a single PM related subscription. description: > - This resource represents an individual subscription for notifications about performance management related events. - The client can use this resource to read and to terminate a subscription to notifications related to NS performance - management. - The client can use this method for reading an individual subscription - about Performance management notifications subscribed by the client. + The client can use this method for reading an individual subscription about Performance management notifications + subscribed by the client. + This method shall follow the provisions specified in the Tables 7.4.8.3.2-1 and 7.4.8.3.2-2 for URI query parameters, + request and response data structures, and response codes. parameters: - name: Accept description: > @@ -846,28 +947,35 @@ paths: required: true type: string responses: - 200: - description: > - The subscription was read successfully. The response body shall - contain a representation of the subscription resource. + 201: + description: 200 OK. + schema: + type: "object" + description: > + The subscription was read successfully. + The response body shall contain a representation of + the subscription resource, as defined in clause 7.5.2.3. + properties: + PmSubscription: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. Content-Type: + type: "string" description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. 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. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -883,9 +991,12 @@ paths: 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: - summary: Individual subscription + summary: Terminate a subscription. description: > This method terminates an individual subscription. + This method shall follow the provisions specified in the + Tables 7.4.8.3.5-1 and 7.4.8.3.5-2 for URI query parameters, + request and response data structures, and response codes parameters: - name: Accept description: > @@ -942,27 +1053,32 @@ paths: summary: > Notification endpoint description: > - This resource represents a notification endpoint for NS performance management. - The API producer can use this resource to send notifications related to - performance management events to a subscribed - API consumer, which has provided the URI of this resource during the subscription process. + 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, + request and response data structures, and response codes. - # Don't know how to pass multiple body parameters. + # Don't know how to pass multiple body parameters. + # Jenkin build is failing if enable more than one body parameters, So commented body parameters. parameters: - - name: performanceInformationAvailableNotification + - name: PerformanceInformationAvailableNotification description: > - Notification about performance information availability. + Notification about performance information availability. in: body required: true schema: - $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" - #- name: thresholdCrossedNotification + properties: + PerformanceInformationAvailableNotification: + $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" + #- name: ThresholdCrossedNotification # description: > - # Notification about threshold crossing + # Notification about threshold crossing. # in: body # required: true # schema: - # $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/ThresholdCrossedNotification" + # properties: + # ThresholdCrossedNotification: + # $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/ThresholdCrossedNotification" - name: Accept description: > Content-Types that are acceptable for the response. @@ -1003,8 +1119,11 @@ paths: get: summary: Notification endpoint. description: > - The GET method allows the server to test the notification endpoint that is provided by the client, - e.g. during subscription. + 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: > diff --git a/src/SOL005/NSPerformanceManagement/definitions/NSPerfomananceManagement_def.yaml b/src/SOL005/NSPerformanceManagement/definitions/NSPerfomananceManagement_def.yaml index 8030980..8acb95f 100644 --- a/src/SOL005/NSPerformanceManagement/definitions/NSPerfomananceManagement_def.yaml +++ b/src/SOL005/NSPerformanceManagement/definitions/NSPerfomananceManagement_def.yaml @@ -1,18 +1,20 @@ definitions: PerformanceReport: description: > - This type defines the format of a performance report provided by the - VNFM to the NFVO as a result of collecting performance information as - part of a PM job. + This type defines the format of a performance report provided by the NFVO + to the OSS/BSS as a result of collecting + performance information as part of a PM job. + The type shall comply with the provisions defined in Table 7.5.2.10-1. type: object required: - entries properties: entries: description: > - List of performance information entries. Each performance report - entry is for a given metric of a given object (i.e. VNF instance), - but can include multiple collected values. + List of performance information entries. Each + performance report entry is for a given metric of a given + object (i.e. NS instance), but can include multiple + collected values. type: array items: type: object @@ -24,15 +26,17 @@ definitions: properties: objectType: description: > - Defines the object type for which performance information is - reported (i.e. VNF type). The string value shall be set to the - vnfdId of the VNF instance to which the performance - information relates. + Defines the object type for which performance + information is reported (i.e. NS type). The string value + shall be set to the nsdId of the NS instance to which the + performance information relates. type: string objectInstanceId: description: > - The object instance (i.e. VNF instance) for which the - performance metric is reported. + The object instance for which the performance metric is + reported. + The object instances for this information element will be + NS instances. $ref: "SOL005_def.yaml#/definitions/Identifier" performanceMetric: description: > @@ -54,10 +58,6 @@ definitions: $ref: "SOL005_def.yaml#/definitions/DateTime" value: description: > - Value of the metric collected. - The type of the "value" attribute (i.e. scalar, - structure (Object in JSON), or array (of scalars, arrays - or structures / Objects)) is assumed to be defined in - the external measurement specification - (see ETSI GS NFV-IFA 027). + The type of the "performanceValue" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, + arrays or structures / Objects)) is outside the scope of the present document. type: object \ No newline at end of file diff --git a/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerfomananceManagement_def.yaml b/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerfomananceManagement_def.yaml index e2b3ab1..6f5ef66 100644 --- a/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerfomananceManagement_def.yaml +++ b/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerfomananceManagement_def.yaml @@ -298,8 +298,8 @@ definitions: description: > Match particular notification types. Permitted values: - * ThresholdCrossedNotification - * PerformanceInformationAvailableNotification + - ThresholdCrossedNotification + - PerformanceInformationAvailableNotification The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. @@ -384,6 +384,7 @@ definitions: - notificationType - subscriptionId - timeStamp + - objectInstanceId - _links properties: id: @@ -440,8 +441,11 @@ definitions: performanceReport: description: > Link from which the available performance - information of data type "PerformanceReport" can be obtained. - This link should point to an "Individual performance report" resource. + information of data type "PerformanceReport" + (see clause 7.5.2.10) can be obtained. + This link should point to an "Individual + performance report" resource as defined in + clause 6.4.3a. $ref: "SOL005_def.yaml#/definitions/Link" ThresholdCrossedNotification: diff --git a/src/SOL005/NSPerformanceManagement/definitions/SOL005_def.yaml b/src/SOL005/NSPerformanceManagement/definitions/SOL005_def.yaml index 058d107..28025f0 100644 --- a/src/SOL005/NSPerformanceManagement/definitions/SOL005_def.yaml +++ b/src/SOL005/NSPerformanceManagement/definitions/SOL005_def.yaml @@ -164,12 +164,12 @@ Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: - * BASIC: In every HTTP request to the notification endpoint, use + - BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. - * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the + - OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained using the client credentials grant type. - * TLS_CERT: Every HTTP request to the notification endpoint is sent + - TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the server is authenticated, but also the client is authenticated during the TLS tunnel setup. @@ -233,4 +233,4 @@ description: > The token endpoint from which the access token can be obtained. Shall be present if it has not been provisioned out of band. - $ref: "#/definitions/Uri" \ No newline at end of file + $ref: "#/definitions/Uri" \ No newline at end of file diff --git a/src/SOL005/NSPerformanceManagement/responses/SOL005_resp.yaml b/src/SOL005/NSPerformanceManagement/responses/SOL005_resp.yaml index d6108c9..d5a535c 100644 --- a/src/SOL005/NSPerformanceManagement/responses/SOL005_resp.yaml +++ b/src/SOL005/NSPerformanceManagement/responses/SOL005_resp.yaml @@ -3,7 +3,7 @@ responses: 303: description: > - See Other + 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. @@ -13,7 +13,7 @@ The response body shall be empty. 400: description: > - Bad Request + Bad Request. Error: Invalid attribute-based filtering parameters. The response body shall contain a ProblemDetails -- GitLab