From 5af7bb2f9576345542bdaced3788b5486f5dfa7f Mon Sep 17 00:00:00 2001 From: rameshnaraya Date: Fri, 7 Dec 2018 15:13:18 +0100 Subject: [PATCH] Merge Request Issue. Re committing NSFM files. --- .../NSFaultManagement/NSFaultManagement.yaml | 224 +++++++++++------- .../SOL005NSFaultManagement_def.yaml | 26 +- .../definitions/SOL005_def.yaml | 29 ++- 3 files changed, 166 insertions(+), 113 deletions(-) diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index c67847c..2d949c9 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -1,9 +1,9 @@ swagger: "2.0" info: version: "2.4.1" - title: DRAFT - SOL005 - NS Fault Management Interface + title: SOL005 - NS Fault Management Interface description: > - DRAFT - SOL005 - NS Fault Management Interface + SOL005 - NS Fault 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 @@ -35,9 +35,9 @@ paths: #SOL005 location: 8.2-1 get: summary: > - Get Alarm List + Query alarms related to NS instances. description: > - Get Alarm List + Get Alarm List. The client can use this method to retrieve information about the alarm list. parameters: @@ -75,11 +75,29 @@ paths: type: string responses: 200: - description: > + description: > + 200 OK. + The request has succeeded. The response body shall contain the list of related alarms. + headers: + 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: - $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm" + type: array + items: + properties: + Alarm: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm" 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -103,16 +121,17 @@ paths: parameters: - name: alarmId description: > - The client can use this method to read an individual alarm. - This method shall follow the provisions specified in the - Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters, - request and response data structures, and response codes.. + Identifier of the alarm. + This identifier can be retrieved from the "id" attribute of the "alarm" attribute in the AlarmNotification or + AlarmClearedNotification. + It can also be retrieved from the "id" attribute of the applicable array element in the + payload body of the response to a GET request to the "Alarms" resource. in: path type: string required: true get: summary: > - Get Individual Alarm + Read individual alarm. description: > The client can use this method to read an individual alarm. parameters: @@ -137,23 +156,30 @@ paths: in: header required: false type: string - responses: + responses: 200: - description: > - OK + description: > + 200 OK. + Information about an individual alarm was read successfully. The response body shall contain a representation of the individual alarm. 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. schema: - $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm" + properties: + Alarm: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm" 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -170,18 +196,24 @@ paths: $ref: "responses/SOL005_resp.yaml#/responses/503" patch: summary: > - Update Alarm. + Acknowledge individual alarm. description: > Acknowledge Alarm This method modifies an individual alarm resource. parameters: - - name: AlarmModifications - description: The parameter for the alarm modification, as defined in clause 8.5.2.8. - in: body + - name: "body" + in: "body" required: true schema: - $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications" + type: "object" + required: + - "AlarmModifications" + properties: + AlarmModifications: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications" + description: > + The parameter for the alarm modification, as defined in clause 8.5.2.8. - name: Accept description: > Content-Types that are acceptable for the response. @@ -207,29 +239,30 @@ paths: enum: ["application/merge-patch+json"] responses: 200: - description: > - OK + description: > + 200 OK. + The request was accepted and completed. The response body shall contain attribute modifications for an 'Individual alarm' resource (see clause 8.5.2.4). 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 + request has provided an invalid authorization token. maximum: 1 - minimum: 0 + minimum: 0 schema: - $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications" + properties: + AlarmModifications: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications" 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -255,10 +288,8 @@ paths: #SOL005 location: 8.2-1 post: summary: > - Create new subscription - description: > - Subscribe - + Subscribe to alarms related to NSs. + description: > The POST method creates a new subscription. This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query parameters, request and response data structures, and response codes. @@ -267,14 +298,8 @@ paths: 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).. - parameters: - - name: FmSubscriptionRequest - description: Details of the subscription to be created, as defined in clause 8.5.2.2. - in: body - required: true - schema: - $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest" + the existing subscription resource with the same filter and callbackUri). + parameters: - name: Accept description: > Content-Types that are acceptable for the response. @@ -295,39 +320,52 @@ paths: Reference: IETF RFC 7231 in: header required: true - type: string + type: string + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "FmSubscriptionRequest" + properties: + FmSubscriptionRequest: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest" + description: > + Details of the subscription to be created, as defined in clause 8.5.2.2. + responses: 201: - description: > - Created - The subscription was created successfully. - The response body shall contain a representation of the - created subscription resource. - The HTTP response shall include a "Location:" HTTP - header that points to the created subscription resource. + description: 201 Created + schema: + type: "object" + description: > + The subscription was created successfully. + The response body shall contain a representation of the + created subscription resource. + The HTTP response shall include a "Location:" HTTP + header that points to the created subscription resource. + properties: + FmSubscription: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription" headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 Location: + type: "string" description: > - The resource URI of the created subscription resource. - type: string - format: url + 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/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 303: $ref: "responses/SOL005_resp.yaml#/responses/303" 400: @@ -346,7 +384,7 @@ paths: $ref: "responses/SOL005_resp.yaml#/responses/503" get: summary: > - Get Subscriptions + Query multiple subscriptions. description: > Query Subscription Information @@ -364,11 +402,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 FmSubscription 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. @@ -392,8 +430,8 @@ paths: type: string responses: 200: - description: > - OK + description: > + 200 OK. The list of subscriptions was queried successfully. The response body shall contain the representations of @@ -401,24 +439,22 @@ paths: invokes the method. 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/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription" + properties: + FmSubscription: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-based-filtering-error" 401: @@ -435,6 +471,7 @@ paths: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" + ############################################################################### # Individual subscription # ############################################################################### @@ -453,7 +490,7 @@ paths: required: true get: summary: > - Get Individual subscription + Read an individual subscription. description: > Query Subscription Information @@ -522,7 +559,7 @@ paths: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: > - Terminate a subscription + Terminate a subscription. description: > Terminate Subscription @@ -538,7 +575,7 @@ paths: responses: 204: description: > - No Content + 204 - No Content. The subscription resource was deleted successfully. The response body shall be empty. @@ -576,10 +613,11 @@ paths: #SOL005 location: 8.2-1 post: summary: > - Notification endpoint + Notify about NS alarms. description: > The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt. - # 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: alarmNotification description: > @@ -587,20 +625,26 @@ paths: in: body required: true schema: - $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification" + properties: + AlarmNotification: + $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification" #- name: alarmClearedNotification # description: > # Information of the clearance of a NS alarm. # in: body # required: true # schema: - # $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification" + # properties: + # AlarmClearedNotification: + # $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification" #- name: alarmListRebuiltNotification # description: > # Information that the alarm list has been rebuilt by the NFVO. # in: body # required: true # schema: + # properties: + # AlarmListRebuiltNotification: # $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification" - name: Accept description: > @@ -639,7 +683,7 @@ paths: 503: $ref: "responses/SOL005_resp.yaml#/responses/503" get: - summary: Notification endpoint. + 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. diff --git a/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml b/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml index 8cfb2da..2feda90 100644 --- a/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml +++ b/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml @@ -9,8 +9,8 @@ definitions: required: - id - managedObjectId + - alarmRaisedTime - rootCauseFaultyComponent - - alarmRaisedTime - ackState - perceivedSeverity - eventTime @@ -51,7 +51,7 @@ definitions: $ref: "SOL005_def.yaml#/definitions/DateTime" ackState: description: > - Acknowledgement state of the alarm. + Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED @@ -241,7 +241,7 @@ definitions: description: > New value of the "ackState" attribute in "Alarm". Permitted values: - * ACKNOWLEDGED + - ACKNOWLEDGED type: string enum: - ACKNOWLEDGED @@ -249,17 +249,17 @@ definitions: description: > The enumeration EventType represents those types of events that trigger an alarm. - * COMMUNICATIONS_ALARM: An alarm of this type is associated with the + - COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). - * PROCESSING_ERROR_ALARM: An alarm of this type is associated with a + - PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). - * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a + - ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). - * QOS_ALARM: An alarm of this type is associated with degradation in the + - QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). - * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment + - EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733). type: string enum: @@ -291,6 +291,10 @@ definitions: description: > The enumeration FaultyResourceType represents those types of faulty resource. + Acceptable values are: + - COMPUTE - Virtual compute resource. + - STORAGE - Virtual storage resource. + - NETWORK - Virtual network resource. type: string enum: - COMPUTE @@ -317,9 +321,9 @@ definitions: description: > Match particular notification types. Permitted values: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification. + - AlarmNotification + - AlarmClearedNotification + - AlarmListRebuiltNotification. type: array items: type: string diff --git a/src/SOL005/NSFaultManagement/definitions/SOL005_def.yaml b/src/SOL005/NSFaultManagement/definitions/SOL005_def.yaml index 01d0557..333b278 100644 --- a/src/SOL005/NSFaultManagement/definitions/SOL005_def.yaml +++ b/src/SOL005/NSFaultManagement/definitions/SOL005_def.yaml @@ -68,7 +68,6 @@ format: URI ResourceHandle: required: - - vimId - resourceId type: object description: > @@ -76,19 +75,19 @@ an NS instance. Information about the resource is available from the VIM. The ResourceHandle type shall comply with the provisions defined in Table 6.5.3.54-1.. properties: - vimConnectionId: + vimId: description: > - Identifier of the VIM connection to manage the resource. This - attribute shall only be supported and present if VNF-related resource - management in direct mode is applicable. The applicable - "VimConnectionInfo" structure, which is referenced by - vimConnectionId, can be obtained from the "vimConnectionInfo" - attribute of the "VnfInstance" structure. + Identifier of the VIM under whose control this resource is placed. + This attribute shall be present if VNF-related resource + management in direct mode is applicable. It shall also + be present for resources that are part of an NS instance + such as virtual link resources. $ref: "#/definitions/Identifier" resourceProviderId: description: > Identifier of the entity responsible for the management of - the resource. This attribute shall only be supported and present when + the resource. + This attribute shall only be supported and present when VNF-related resource management in indirect mode is applicable. The identification scheme is outside the scope of the present document. @@ -100,8 +99,7 @@ $ref: "#/definitions/IdentifierInVim" vimLevelResourceType: description: > - Type of the resource in the scope of the VIM or the - resource provider. + Type of the resource in the scope of the VIM or the resource provider. type: string IdentifierInVim: @@ -214,6 +212,11 @@ String formatted according to IETF RFC 3986. type: string + String: + description: > + This type represents stack of string values + type: string + NsInstanceSubscriptionFilter: required: - nsdIds @@ -261,4 +264,6 @@ description: > If present, match NS instances with a NS Instance Name listed in this attribute. - type: string \ No newline at end of file + type: array + items: + $ref: "#/definitions/String" \ No newline at end of file -- GitLab