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/metrics/{requiredMetricName}:
  20     get:
  21       tags:
  22       - Actuator
  23       summary: Actuator web endpoint 'metrics-requiredMetricName'
  24       operationId: metrics-requiredMetricName_2
  25       parameters:
  26       - name: requiredMetricName
  27         in: path
  28         required: true
  29         style: simple
  30         explode: false
  31         schema:
  32           type: string
  33       responses:
  34         200:
  35           description: OK
  36           content:
  37             '*/*':
  38               schema:
  39                 type: object
  40   /actuator:
  41     get:
  42       tags:
  43       - Actuator
  44       summary: Actuator root web endpoint
  45       operationId: links_1
  46       responses:
  47         200:
  48           description: OK
  49           content:
  50             '*/*':
  51               schema:
  52                 type: object
  53                 additionalProperties:
  54                   type: object
  55                   additionalProperties:
  56                     $ref: '#/components/schemas/Link'
  57   /actuator/threaddump:
  58     get:
  59       tags:
  60       - Actuator
  61       summary: Actuator web endpoint 'threaddump'
  62       operationId: threaddump_4
  63       responses:
  64         200:
  65           description: OK
  66           content:
  67             '*/*':
  68               schema:
  69                 type: object
  70   /actuator/logfile:
  71     get:
  72       tags:
  73       - Actuator
  74       summary: Actuator web endpoint 'logfile'
  75       operationId: logfile_2
  76       responses:
  77         200:
  78           description: OK
  79           content:
  80             '*/*':
  81               schema:
  82                 type: object
  83   /actuator/loggers/{name}:
  84     get:
  85       tags:
  86       - Actuator
  87       summary: Actuator web endpoint 'loggers-name'
  88       operationId: loggers-name_4
  89       parameters:
  90       - name: name
  91         in: path
  92         required: true
  93         style: simple
  94         explode: false
  95         schema:
  96           type: string
  97       responses:
  98         200:
  99           description: OK
 100           content:
 101             '*/*':
 102               schema:
 103                 type: object
 104     post:
 105       tags:
 106       - Actuator
 107       summary: Actuator web endpoint 'loggers-name'
 108       operationId: loggers-name_3
 109       parameters:
 110       - name: name
 111         in: path
 112         required: true
 113         style: simple
 114         explode: false
 115         schema:
 116           type: string
 117       responses:
 118         200:
 119           description: OK
 120           content:
 121             '*/*':
 122               schema:
 123                 type: object
 124   /actuator/info:
 125     get:
 126       tags:
 127       - Actuator
 128       summary: Actuator web endpoint 'info'
 129       operationId: info_2
 130       responses:
 131         200:
 132           description: OK
 133           content:
 134             '*/*':
 135               schema:
 136                 type: object
 137   /actuator/health:
 138     get:
 139       tags:
 140       - Actuator
 141       summary: Actuator web endpoint 'health'
 142       operationId: health_2
 143       responses:
 144         200:
 145           description: OK
 146           content:
 147             '*/*':
 148               schema:
 149                 type: object
 150   /actuator/loggers:
 151     get:
 152       tags:
 153       - Actuator
 154       summary: Actuator web endpoint 'loggers'
 155       operationId: loggers_2
 156       responses:
 157         200:
 158           description: OK
 159           content:
 160             '*/*':
 161               schema:
 162                 type: object
 163   /actuator/health/**:
 164     get:
 165       tags:
 166       - Actuator
 167       summary: Actuator web endpoint 'health-path'
 168       operationId: health-path_2
 169       responses:
 170         200:
 171           description: OK
 172           content:
 173             '*/*':
 174               schema:
 175                 type: object
 176   /actuator/metrics:
 177     get:
 178       tags:
 179       - Actuator
 180       summary: Actuator web endpoint 'metrics'
 181       operationId: metrics_2
 182       responses:
 183         200:
 184           description: OK
 185           content:
 186             '*/*':
 187               schema:
 188                 type: object
 189   /actuator/heapdump:
 190     get:
 191       tags:
 192       - Actuator
 193       summary: Actuator web endpoint 'heapdump'
 194       operationId: heapdump_2
 195       responses:
 196         200:
 197           description: OK
 198           content:
 199             '*/*':
 200               schema:
 201                 type: object
 202   /actuator/shutdown:
 203     post:
 204       tags:
 205       - Actuator
 206       summary: Actuator web endpoint 'shutdown'
 207       operationId: shutdown_2
 208       responses:
 209         200:
 210           description: OK
 211           content:
 212             '*/*':
 213               schema:
 214                 type: object
 215 components:
 216   schemas:
 217     Link:
 218       type: object
 219       properties:
 220         templated:
 221           type: boolean
 222         href:
 223           type: string