pmlog/api/pmlog-api.json

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