From 4cd9e95b2de965ba0240f5c3c0460f84183d3fc0 Mon Sep 17 00:00:00 2001 From: Atul Agarwal Date: Thu, 20 May 2021 09:24:26 +0000 Subject: [PATCH 1/1] Added apis for Feature 10339 - Enhanced Alarm Mgmt. (SOL005 FM Interface) Change-Id: I429cfa7e9241008d0db825d218b51f0322b4bdb9 Signed-off-by: Atul Agarwal --- osm-openapi.yaml | 188 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+) diff --git a/osm-openapi.yaml b/osm-openapi.yaml index b641bf2..aaee616 100644 --- a/osm-openapi.yaml +++ b/osm-openapi.yaml @@ -2261,6 +2261,133 @@ paths: $ref: '#/components/responses/UnexpectedError' # END NS Instances +# BEGIN Alarms + '/nsfm/v1/alarms': + get: + tags: + - "Alarms" + summary: Query information about multiple alarms + description: Query information about multiple alarms + operationId: getAlarms + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayOfAlarm' + application/yaml: + schema: + $ref: '#/components/schemas/ArrayOfAlarm' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + '/nsfm/v1/alarms/{uuid}': + parameters: + - name: uuid + in: path + required: true + description: Alarm UUID + schema: + type: string + get: + tags: + - "Alarms" + summary: Read an individual Alarm + description: Read an individual Alarm + operationId: getAlarm + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Alarm' + application/yaml: + schema: + $ref: '#/components/schemas/Alarm' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + patch: + tags: + - "Alarms" + summary: Modify the data of an individual Alarm + description: Modify the data of an individual Alarm + operationId: updateAlarm + requestBody: + $ref: '#/components/requestBodies/AlarmInfoModifications' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' +# END Alarms + # BEGIN NetSlice Templates '/nst/v1/netslice_templates': get: @@ -6200,6 +6327,20 @@ components: description: description: NSD Description type: string + AlarmInfoModifications: + description: | + Alarm Information + type: object + properties: + id: + description: UUID + type: string + is_enable: + description: To enable/disable the alarm. + type: string + threshold: + description: Threshold value of the Alarm + type: string NsdInfo: description: | NS Descriptor Information @@ -6924,6 +7065,45 @@ components: type: array items: $ref: '#/components/schemas/NetSliceInstance' + Alarm: + description: | + Alarm Information + type: object + properties: + _id: + description: Identifier of the Alarm. + type: string + format: uuid + id: + description: Identifier of the Alarm. + type: string + format: uuid + metric: + description: Alarm metric. + type: string + threshold: + description: Threshold value of the Alarm. + type: number + format: float + operation: + description: Operation to be applied. + type: string + action: + description: Action to be taken. + type: string + status: + description: Current status of the alarm. + type: string + required: + - _id + - id + - metric + - threshold + - operation + ArrayOfAlarm: + type: array + items: + $ref: '#/components/schemas/Alarm' # CreateNsiRequest: # Substituted by InstantiateNsiRequest InstantiateNsiRequest: @@ -8555,6 +8735,14 @@ components: application/yaml: schema: $ref: '#/components/schemas/NsdInfoModifications' + AlarmInfoModifications: + content: + application/json: + schema: + $ref: '#/components/schemas/AlarmInfoModifications' + application/yaml: + schema: + $ref: '#/components/schemas/AlarmInfoModifications' NsDescriptor: content: text/plain: -- 2.25.1