kubernetes/dcaegen2-services/resources/external/schemas/sa88-rel16/PerThresMonMnS.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: TS 28.532 Performance Threshold Monitoring Service
   4   version: 16.4.0
   5   description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service
   6 servers:
   7   - url: 'http://{monitoringNotifTarget}'
   8     variables:
   9       monitoringNotifTarget:
  10         description: >-
  11           The open API server of the performance threshold monitoring service is
  12           located in the consumer side, see monitoringNotifTarget attribute of
  13           the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11].
  14         default: example.com
  15 paths:
  16   /notificationSink:
  17     post:
  18       summary: Send notifications about performance threshold crossing
  19       description: To send a notifyThresholdCrossing notification
  20       requestBody:
  21         required: true
  22         content:
  23           application/json:
  24             schema:
  25               $ref: '#/components/schemas/notifyThresholdCrossing-NotifType'
  26       responses:
  27         '204':
  28           description: >-
  29             Success case ("204 No Content"). The notification is successfully
  30             delivered. The response message body is absent.
  31         default:
  32           description: Error case.
  33           content:
  34             application/json:
  35               schema:
  36                 $ref: '#/components/schemas/error-ResponseType'
  37 components:
  38   schemas:
  39     dateTime-Type:
  40       type: string
  41       format: date-Time
  42     uri-Type:
  43       type: string
  44     long-Type:
  45       type: string
  46       format: long
  47     thresholdLevel-Type:
  48       type: integer
  49     measurementTypeName-Type:
  50       type: string
  51     measurementValue-Type:
  52       type: string
  53     additionalText-Type:
  54       type: string
  55     error-ResponseType:
  56       type: object
  57       properties:
  58         error:
  59           type: object
  60           properties:
  61             errorInfo:
  62               type: string
  63     header-Type:
  64       description: Header used in notifications as notification header
  65       type: object
  66       properties:
  67         uri:
  68           $ref: '#/components/schemas/uri-Type'
  69         notificationId:
  70           $ref: '#/components/schemas/notificationId-Type'
  71         notificationType:
  72           $ref: '#/components/schemas/notificationType-Type'
  73         eventTime:
  74           $ref: '#/components/schemas/dateTime-Type'
  75     notificationId-Type:
  76       $ref: '#/components/schemas/long-Type'
  77     notificationType-Type:
  78       type: string
  79       enum:
  80         - notifyThresholdCrossing
  81     notifyThresholdCrossing-NotifType:
  82       type: object
  83       properties:
  84         header:
  85           $ref: '#/components/schemas/header-Type'
  86         body:
  87           type: object
  88           properties:
  89             startOfMonitoringGP:
  90               $ref: '#/components/schemas/dateTime-Type'
  91             endOfMonitoringGP:
  92               $ref: '#/components/schemas/dateTime-Type'
  93             monitoredObjectInstance:
  94               $ref: '#/components/schemas/uri-Type'
  95             thresholdLevel:
  96               $ref: '#/components/schemas/thresholdLevel-Type'
  97             measurementTypeName:
  98               $ref: '#/components/schemas/measurementTypeName-Type'
  99             measurementValue:
 100               $ref: '#/components/schemas/measurementValue-Type'
 101             additionalText:
 102               $ref: '#/components/schemas/additionalText-Type'