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: Actuator
  14   description: Monitor and interact
  15   externalDocs:
  16     description: Spring Boot Actuator Web API Documentation
  17     url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
  18 paths:
  19   /actuator/threaddump:
  20     get:
  21       tags:
  22       - Actuator
  23       summary: Actuator web endpoint 'threaddump'
  24       operationId: threaddump
  25       responses:
  26         200:
  27           description: OK
  28           content:
  29             text/plain;charset=UTF-8:
  30               schema:
  31                 type: object
  32             application/vnd.spring-boot.actuator.v3+json:
  33               schema:
  34                 type: object
  35             application/json:
  36               schema:
  37                 type: object
  38             application/vnd.spring-boot.actuator.v2+json:
  39               schema:
  40                 type: object
  41   /actuator/info:
  42     get:
  43       tags:
  44       - Actuator
  45       summary: Actuator web endpoint 'info'
  46       operationId: info
  47       responses:
  48         200:
  49           description: OK
  50           content:
  51             application/vnd.spring-boot.actuator.v3+json:
  52               schema:
  53                 type: object
  54             application/json:
  55               schema:
  56                 type: object
  57             application/vnd.spring-boot.actuator.v2+json:
  58               schema:
  59                 type: object
  60   /actuator/loggers:
  61     get:
  62       tags:
  63       - Actuator
  64       summary: Actuator web endpoint 'loggers'
  65       operationId: loggers
  66       responses:
  67         200:
  68           description: OK
  69           content:
  70             application/vnd.spring-boot.actuator.v3+json:
  71               schema:
  72                 type: object
  73             application/json:
  74               schema:
  75                 type: object
  76             application/vnd.spring-boot.actuator.v2+json:
  77               schema:
  78                 type: object
  79   /actuator/health/**:
  80     get:
  81       tags:
  82       - Actuator
  83       summary: Actuator web endpoint 'health-path'
  84       operationId: health-path
  85       responses:
  86         200:
  87           description: OK
  88           content:
  89             application/vnd.spring-boot.actuator.v3+json:
  90               schema:
  91                 type: object
  92             application/json:
  93               schema:
  94                 type: object
  95             application/vnd.spring-boot.actuator.v2+json:
  96               schema:
  97                 type: object
  98   /actuator/shutdown:
  99     post:
 100       tags:
 101       - Actuator
 102       summary: Actuator web endpoint 'shutdown'
 103       operationId: shutdown
 104       responses:
 105         200:
 106           description: OK
 107           content:
 108             application/vnd.spring-boot.actuator.v3+json:
 109               schema:
 110                 type: object
 111             application/json:
 112               schema:
 113                 type: object
 114             application/vnd.spring-boot.actuator.v2+json:
 115               schema:
 116                 type: object
 117   /actuator/metrics/{requiredMetricName}:
 118     get:
 119       tags:
 120       - Actuator
 121       summary: Actuator web endpoint 'metrics-requiredMetricName'
 122       operationId: metrics-requiredMetricName
 123       parameters:
 124       - name: requiredMetricName
 125         in: path
 126         required: true
 127         style: simple
 128         explode: false
 129         schema:
 130           type: string
 131       responses:
 132         200:
 133           description: OK
 134           content:
 135             application/vnd.spring-boot.actuator.v3+json:
 136               schema:
 137                 type: object
 138             application/json:
 139               schema:
 140                 type: object
 141             application/vnd.spring-boot.actuator.v2+json:
 142               schema:
 143                 type: object
 144   /actuator:
 145     get:
 146       tags:
 147       - Actuator
 148       summary: Actuator root web endpoint
 149       operationId: links
 150       responses:
 151         200:
 152           description: OK
 153           content:
 154             application/vnd.spring-boot.actuator.v3+json:
 155               schema:
 156                 type: object
 157                 additionalProperties:
 158                   type: object
 159                   additionalProperties:
 160                     $ref: '#/components/schemas/Link'
 161             application/json:
 162               schema:
 163                 type: object
 164                 additionalProperties:
 165                   type: object
 166                   additionalProperties:
 167                     $ref: '#/components/schemas/Link'
 168             application/vnd.spring-boot.actuator.v2+json:
 169               schema:
 170                 type: object
 171                 additionalProperties:
 172                   type: object
 173                   additionalProperties:
 174                     $ref: '#/components/schemas/Link'
 175   /actuator/logfile:
 176     get:
 177       tags:
 178       - Actuator
 179       summary: Actuator web endpoint 'logfile'
 180       operationId: logfile
 181       responses:
 182         200:
 183           description: OK
 184           content:
 185             text/plain;charset=UTF-8:
 186               schema:
 187                 type: object
 188   /data-consumer/v1/info-jobs/{infoJobId}:
 189     put:
 190       tags:
 191       - Information Coordinator Service Simulator (exists only in test)
 192       operationId: putIndividualInfoJob
 193       parameters:
 194       - name: infoJobId
 195         in: path
 196         required: true
 197         style: simple
 198         explode: false
 199         schema:
 200           type: string
 201       requestBody:
 202         content:
 203           application/json:
 204             schema:
 205               type: string
 206         required: true
 207       responses:
 208         200:
 209           description: OK
 210           content:
 211             application/json:
 212               schema:
 213                 type: object
 214   /actuator/loggers/{name}:
 215     get:
 216       tags:
 217       - Actuator
 218       summary: Actuator web endpoint 'loggers-name'
 219       operationId: loggers-name
 220       parameters:
 221       - name: name
 222         in: path
 223         required: true
 224         style: simple
 225         explode: false
 226         schema:
 227           type: string
 228       responses:
 229         200:
 230           description: OK
 231           content:
 232             application/vnd.spring-boot.actuator.v3+json:
 233               schema:
 234                 type: object
 235             application/json:
 236               schema:
 237                 type: object
 238             application/vnd.spring-boot.actuator.v2+json:
 239               schema:
 240                 type: object
 241     post:
 242       tags:
 243       - Actuator
 244       summary: Actuator web endpoint 'loggers-name'
 245       operationId: loggers-name_2
 246       parameters:
 247       - name: name
 248         in: path
 249         required: true
 250         style: simple
 251         explode: false
 252         schema:
 253           type: string
 254       requestBody:
 255         content:
 256           application/json:
 257             schema:
 258               type: string
 259               enum:
 260               - TRACE
 261               - DEBUG
 262               - INFO
 263               - WARN
 264               - ERROR
 265               - FATAL
 266               - OFF
 267       responses:
 268         200:
 269           description: OK
 270           content:
 271             '*/*':
 272               schema:
 273                 type: object
 274   /actuator/health:
 275     get:
 276       tags:
 277       - Actuator
 278       summary: Actuator web endpoint 'health'
 279       operationId: health
 280       responses:
 281         200:
 282           description: OK
 283           content:
 284             application/vnd.spring-boot.actuator.v3+json:
 285               schema:
 286                 type: object
 287             application/json:
 288               schema:
 289                 type: object
 290             application/vnd.spring-boot.actuator.v2+json:
 291               schema:
 292                 type: object
 293   /actuator/metrics:
 294     get:
 295       tags:
 296       - Actuator
 297       summary: Actuator web endpoint 'metrics'
 298       operationId: metrics
 299       responses:
 300         200:
 301           description: OK
 302           content:
 303             application/vnd.spring-boot.actuator.v3+json:
 304               schema:
 305                 type: object
 306             application/json:
 307               schema:
 308                 type: object
 309             application/vnd.spring-boot.actuator.v2+json:
 310               schema:
 311                 type: object
 312   /actuator/heapdump:
 313     get:
 314       tags:
 315       - Actuator
 316       summary: Actuator web endpoint 'heapdump'
 317       operationId: heapdump
 318       responses:
 319         200:
 320           description: OK
 321           content:
 322             application/octet-stream:
 323               schema:
 324                 type: object
 325 components:
 326   schemas:
 327     Link:
 328       type: object
 329       properties:
 330         templated:
 331           type: boolean
 332         href:
 333           type: string