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_4",
  14             "responses": {"200": {
  15                 "description": "OK",
  16                 "content": {"*/*": {"schema": {"type": "object"}}}
  17             }},
  18             "tags": ["Actuator"]
  19         }},
  20         "/actuator/info": {"get": {
  21             "summary": "Actuator web endpoint 'info'",
  22             "operationId": "info_2",
  23             "responses": {"200": {
  24                 "description": "OK",
  25                 "content": {"*/*": {"schema": {"type": "object"}}}
  26             }},
  27             "tags": ["Actuator"]
  28         }},
  29         "/actuator/loggers": {"get": {
  30             "summary": "Actuator web endpoint 'loggers'",
  31             "operationId": "loggers_2",
  32             "responses": {"200": {
  33                 "description": "OK",
  34                 "content": {"*/*": {"schema": {"type": "object"}}}
  35             }},
  36             "tags": ["Actuator"]
  37         }},
  38         "/actuator/health/**": {"get": {
  39             "summary": "Actuator web endpoint 'health-path'",
  40             "operationId": "health-path_2",
  41             "responses": {"200": {
  42                 "description": "OK",
  43                 "content": {"*/*": {"schema": {"type": "object"}}}
  44             }},
  45             "tags": ["Actuator"]
  46         }},
  47         "/actuator/shutdown": {"post": {
  48             "summary": "Actuator web endpoint 'shutdown'",
  49             "operationId": "shutdown_2",
  50             "responses": {"200": {
  51                 "description": "OK",
  52                 "content": {"*/*": {"schema": {"type": "object"}}}
  53             }},
  54             "tags": ["Actuator"]
  55         }},
  56         "/actuator/metrics/{requiredMetricName}": {"get": {
  57             "summary": "Actuator web endpoint 'metrics-requiredMetricName'",
  58             "operationId": "metrics-requiredMetricName_2",
  59             "responses": {"200": {
  60                 "description": "OK",
  61                 "content": {"*/*": {"schema": {"type": "object"}}}
  62             }},
  63             "parameters": [{
  64                 "schema": {"type": "string"},
  65                 "in": "path",
  66                 "name": "requiredMetricName",
  67                 "required": true
  68             }],
  69             "tags": ["Actuator"]
  70         }},
  71         "/actuator": {"get": {
  72             "summary": "Actuator root web endpoint",
  73             "operationId": "links_1",
  74             "responses": {"200": {
  75                 "description": "OK",
  76                 "content": {"*/*": {"schema": {
  77                     "additionalProperties": {
  78                         "additionalProperties": {"$ref": "#/components/schemas/Link"},
  79                         "type": "object"
  80                     },
  81                     "type": "object"
  82                 }}}
  83             }},
  84             "tags": ["Actuator"]
  85         }},
  86         "/actuator/logfile": {"get": {
  87             "summary": "Actuator web endpoint 'logfile'",
  88             "operationId": "logfile_2",
  89             "responses": {"200": {
  90                 "description": "OK",
  91                 "content": {"*/*": {"schema": {"type": "object"}}}
  92             }},
  93             "tags": ["Actuator"]
  94         }},
  95         "/data-consumer/v1/info-jobs/{infoJobId}": {"put": {
  96             "requestBody": {
  97                 "content": {"application/json": {"schema": {"type": "string"}}},
  98                 "required": true
  99             },
 100             "operationId": "putIndividualInfoJob",
 101             "responses": {"200": {
 102                 "description": "OK",
 103                 "content": {"application/json": {"schema": {"type": "object"}}}
 104             }},
 105             "parameters": [{
 106                 "schema": {"type": "string"},
 107                 "in": "path",
 108                 "name": "infoJobId",
 109                 "required": true
 110             }],
 111             "tags": ["Information Coordinator Service Simulator (exists only in test)"]
 112         }},
 113         "/actuator/loggers/{name}": {
 114             "post": {
 115                 "summary": "Actuator web endpoint 'loggers-name'",
 116                 "operationId": "loggers-name_3",
 117                 "responses": {"200": {
 118                     "description": "OK",
 119                     "content": {"*/*": {"schema": {"type": "object"}}}
 120                 }},
 121                 "parameters": [{
 122                     "schema": {"type": "string"},
 123                     "in": "path",
 124                     "name": "name",
 125                     "required": true
 126                 }],
 127                 "tags": ["Actuator"]
 128             },
 129             "get": {
 130                 "summary": "Actuator web endpoint 'loggers-name'",
 131                 "operationId": "loggers-name_4",
 132                 "responses": {"200": {
 133                     "description": "OK",
 134                     "content": {"*/*": {"schema": {"type": "object"}}}
 135                 }},
 136                 "parameters": [{
 137                     "schema": {"type": "string"},
 138                     "in": "path",
 139                     "name": "name",
 140                     "required": true
 141                 }],
 142                 "tags": ["Actuator"]
 143             }
 144         },
 145         "/actuator/health": {"get": {
 146             "summary": "Actuator web endpoint 'health'",
 147             "operationId": "health_2",
 148             "responses": {"200": {
 149                 "description": "OK",
 150                 "content": {"*/*": {"schema": {"type": "object"}}}
 151             }},
 152             "tags": ["Actuator"]
 153         }},
 154         "/actuator/metrics": {"get": {
 155             "summary": "Actuator web endpoint 'metrics'",
 156             "operationId": "metrics_2",
 157             "responses": {"200": {
 158                 "description": "OK",
 159                 "content": {"*/*": {"schema": {"type": "object"}}}
 160             }},
 161             "tags": ["Actuator"]
 162         }},
 163         "/actuator/heapdump": {"get": {
 164             "summary": "Actuator web endpoint 'heapdump'",
 165             "operationId": "heapdump_2",
 166             "responses": {"200": {
 167                 "description": "OK",
 168                 "content": {"*/*": {"schema": {"type": "object"}}}
 169             }},
 170             "tags": ["Actuator"]
 171         }}
 172     },
 173     "info": {
 174         "license": {
 175             "name": "Copyright (C) 2023 Nordix Foundation. Licensed under the Apache License.",
 176             "url": "http://www.apache.org/licenses/LICENSE-2.0"
 177         },
 178         "description": "Receives PM reports from a Kafka topic and writes the PM counters into an Influx database.",
 179         "title": "PM Logger",
 180         "version": "1.0"
 181     },
 182     "tags": [
 183         {"name": "Information Coordinator Service Simulator (exists only in test)"},
 184         {
 185             "name": "Actuator",
 186             "description": "Monitor and interact",
 187             "externalDocs": {
 188                 "description": "Spring Boot Actuator Web API Documentation",
 189                 "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"
 190             }
 191         }
 192     ]
 193 }