pmlog/api/pmlog-api.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: PM Logger
   4   description: Receives PM reports from a Kafka topic and writes the PM counters into
   5     an Influx database.
   6   license:
   7     name: Copyright (C) 2023 Nordix Foundation. Licensed under the Apache License.
   8     url: http://www.apache.org/licenses/LICENSE-2.0
   9   version: "1.0"
  10 servers:
  11 - url: /
  12 tags:
  13 - name: Information Coordinator Service Simulator (exists only in test)
  14 - name: Actuator
  15   description: Monitor and interact
  16   externalDocs:
  17     description: Spring Boot Actuator Web API Documentation
  18     url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
  19 paths:
  20   /actuator/threaddump:
  21     get:
  22       tags:
  23       - Actuator
  24       summary: Actuator web endpoint 'threaddump'
  25       operationId: threaddump_4
  26       responses:
  27         200:
  28           description: OK
  29           content:
  30             '*/*':
  31               schema:
  32                 type: object
  33   /actuator/info:
  34     get:
  35       tags:
  36       - Actuator
  37       summary: Actuator web endpoint 'info'
  38       operationId: info_2
  39       responses:
  40         200:
  41           description: OK
  42           content:
  43             '*/*':
  44               schema:
  45                 type: object
  46   /actuator/loggers:
  47     get:
  48       tags:
  49       - Actuator
  50       summary: Actuator web endpoint 'loggers'
  51       operationId: loggers_2
  52       responses:
  53         200:
  54           description: OK
  55           content:
  56             '*/*':
  57               schema:
  58                 type: object
  59   /actuator/health/**:
  60     get:
  61       tags:
  62       - Actuator
  63       summary: Actuator web endpoint 'health-path'
  64       operationId: health-path_2
  65       responses:
  66         200:
  67           description: OK
  68           content:
  69             '*/*':
  70               schema:
  71                 type: object
  72   /actuator/shutdown:
  73     post:
  74       tags:
  75       - Actuator
  76       summary: Actuator web endpoint 'shutdown'
  77       operationId: shutdown_2
  78       responses:
  79         200:
  80           description: OK
  81           content:
  82             '*/*':
  83               schema:
  84                 type: object
  85   /actuator/metrics/{requiredMetricName}:
  86     get:
  87       tags:
  88       - Actuator
  89       summary: Actuator web endpoint 'metrics-requiredMetricName'
  90       operationId: metrics-requiredMetricName_2
  91       parameters:
  92       - name: requiredMetricName
  93         in: path
  94         required: true
  95         style: simple
  96         explode: false
  97         schema:
  98           type: string
  99       responses:
 100         200:
 101           description: OK
 102           content:
 103             '*/*':
 104               schema:
 105                 type: object
 106   /actuator:
 107     get:
 108       tags:
 109       - Actuator
 110       summary: Actuator root web endpoint
 111       operationId: links_1
 112       responses:
 113         200:
 114           description: OK
 115           content:
 116             '*/*':
 117               schema:
 118                 type: object
 119                 additionalProperties:
 120                   type: object
 121                   additionalProperties:
 122                     $ref: '#/components/schemas/Link'
 123   /actuator/logfile:
 124     get:
 125       tags:
 126       - Actuator
 127       summary: Actuator web endpoint 'logfile'
 128       operationId: logfile_2
 129       responses:
 130         200:
 131           description: OK
 132           content:
 133             '*/*':
 134               schema:
 135                 type: object
 136   /data-consumer/v1/info-jobs/{infoJobId}:
 137     put:
 138       tags:
 139       - Information Coordinator Service Simulator (exists only in test)
 140       operationId: putIndividualInfoJob
 141       parameters:
 142       - name: infoJobId
 143         in: path
 144         required: true
 145         style: simple
 146         explode: false
 147         schema:
 148           type: string
 149       requestBody:
 150         content:
 151           application/json:
 152             schema:
 153               type: string
 154         required: true
 155       responses:
 156         200:
 157           description: OK
 158           content:
 159             application/json:
 160               schema:
 161                 type: object
 162   /actuator/loggers/{name}:
 163     get:
 164       tags:
 165       - Actuator
 166       summary: Actuator web endpoint 'loggers-name'
 167       operationId: loggers-name_4
 168       parameters:
 169       - name: name
 170         in: path
 171         required: true
 172         style: simple
 173         explode: false
 174         schema:
 175           type: string
 176       responses:
 177         200:
 178           description: OK
 179           content:
 180             '*/*':
 181               schema:
 182                 type: object
 183     post:
 184       tags:
 185       - Actuator
 186       summary: Actuator web endpoint 'loggers-name'
 187       operationId: loggers-name_3
 188       parameters:
 189       - name: name
 190         in: path
 191         required: true
 192         style: simple
 193         explode: false
 194         schema:
 195           type: string
 196       responses:
 197         200:
 198           description: OK
 199           content:
 200             '*/*':
 201               schema:
 202                 type: object
 203   /actuator/health:
 204     get:
 205       tags:
 206       - Actuator
 207       summary: Actuator web endpoint 'health'
 208       operationId: health_2
 209       responses:
 210         200:
 211           description: OK
 212           content:
 213             '*/*':
 214               schema:
 215                 type: object
 216   /actuator/metrics:
 217     get:
 218       tags:
 219       - Actuator
 220       summary: Actuator web endpoint 'metrics'
 221       operationId: metrics_2
 222       responses:
 223         200:
 224           description: OK
 225           content:
 226             '*/*':
 227               schema:
 228                 type: object
 229   /actuator/heapdump:
 230     get:
 231       tags:
 232       - Actuator
 233       summary: Actuator web endpoint 'heapdump'
 234       operationId: heapdump_2
 235       responses:
 236         200:
 237           description: OK
 238           content:
 239             '*/*':
 240               schema:
 241                 type: object
 242 components:
 243   schemas:
 244     Link:
 245       type: object
 246       properties:
 247         templated:
 248           type: boolean
 249         href:
 250           type: string