kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/perfMnS.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: TS 28.532 Performance Threshold Monitoring MnS
   4   version: 16.6.0
   5   description: >-
   6     OAS 3.0.1 definition of the Performance Threshold Monitoring MnS
   7     © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
   8     All rights reserved.
   9 externalDocs:
  10   description: 3GPP TS 28.532 V16.6.0; Generic management services
  11   url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
  12 servers:
  13   - url: '{root}'
  14     variables:
  15       root:
  16         description: >-
  17           The open API server of the performance threshold monitoring service is
  18           located in the consumer side, see monitoringNotifTarget attribute of
  19           the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11].
  20         default: http://example.com/3GPPManagement
  21 paths:
  22   /notificationSink:
  23     post:
  24       summary: Send notifications about performance threshold crossing
  25       description: To send a notifyThresholdCrossing notification
  26       requestBody:
  27         required: true
  28         content:
  29           application/json:
  30             schema:
  31               $ref: '#/components/schemas/NotifyThresholdCrossing'
  32       responses:
  33         '204':
  34           description: >-
  35             Success case ("204 No Content"). The notification is successfully
  36             delivered. The response message body is absent.
  37         default:
  38           description: Error case.
  39           content:
  40             application/json:
  41               schema:
  42                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
  43 components:
  44   schemas:
  45     PerfNotificationTypes:
  46       type: string
  47       enum:
  48         - notifyThresholdCrossing
  49     PerfMetricValue:
  50       oneOf:
  51         - type: integer
  52         - $ref: 'comDefs.yaml#/components/schemas/Float'
  53     PerfMetricDirection:
  54       type: string
  55       enum:
  56         - UP
  57         - DOWN
  58     NotifyThresholdCrossing:
  59       allOf:
  60         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
  61         - type: object
  62           properties:
  63             observedPerfMetricName:
  64               type: string
  65             observedPerfMetricValue:
  66               $ref: '#/components/schemas/PerfMetricValue'
  67             observedPerfMetricDirection:
  68               $ref: '#/components/schemas/PerfMetricDirection'
  69             thresholdValue:
  70               $ref: '#/components/schemas/PerfMetricValue'
  71             hysteresis:
  72               $ref: '#/components/schemas/PerfMetricValue'
  73             monitorGranularityPeriod:
  74               type: integer
  75             additionalText:
  76               type: string