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