3 title: PM Measuremenet Data Producer
4 description: Distributes PM Measuremenet Data to consumers
6 name: Copyright (C) 2023 Nordix Foundation. Licensed under the Apache License.
7 url: http://www.apache.org/licenses/LICENSE-2.0
13 description: Monitor and interact
15 description: Spring Boot Actuator Web API Documentation
16 url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
22 summary: Actuator web endpoint 'threaddump'
23 operationId: threaddump
28 text/plain;charset=UTF-8:
31 application/vnd.spring-boot.actuator.v3+json:
37 application/vnd.spring-boot.actuator.v2+json:
44 summary: Actuator web endpoint 'info'
50 application/vnd.spring-boot.actuator.v3+json:
56 application/vnd.spring-boot.actuator.v2+json:
59 /data-producer/v1/info-types/{infoTypeId}:
62 - Information Coordinator Service Simulator (exists only in test)
63 operationId: putInfoType
76 $ref: '#/components/schemas/producer_info_type_info'
88 - Producer job control API
89 summary: Returns statistics
90 operationId: getStatistics
97 $ref: '#/components/schemas/statistics_info'
98 /generic_dataproducer/health_check:
101 - Producer job control API
102 summary: Producer supervision
103 description: The endpoint is provided by the Information Producer and is used
104 for supervision of the producer.
105 operationId: producerSupervision
108 description: The producer is OK
113 /generic_dataproducer/info_job:
116 - Producer job control API
117 summary: Get all jobs
118 description: Returns all info jobs, can be used for trouble shooting
122 description: Information jobs
128 $ref: '#/components/schemas/producer_info_job_request'
131 - Producer job control API
132 summary: Callback for Information Job creation/modification
133 description: The call is invoked to activate or to modify a data subscription.
134 The endpoint is provided by the Information Producer.
135 operationId: jobCreatedCallback
148 $ref: '#/components/schemas/void'
150 description: Other error in the request
154 $ref: '#/components/schemas/error_information'
156 description: Information type is not found
160 $ref: '#/components/schemas/error_information'
165 summary: Actuator web endpoint 'loggers'
171 application/vnd.spring-boot.actuator.v3+json:
177 application/vnd.spring-boot.actuator.v2+json:
184 summary: Actuator web endpoint 'health-path'
185 operationId: health-path
190 application/vnd.spring-boot.actuator.v3+json:
196 application/vnd.spring-boot.actuator.v2+json:
203 summary: Actuator web endpoint 'shutdown'
204 operationId: shutdown
209 application/vnd.spring-boot.actuator.v3+json:
215 application/vnd.spring-boot.actuator.v2+json:
218 /data-producer/v1/info-producers/{infoProducerId}:
221 - Information Coordinator Service Simulator (exists only in test)
222 operationId: getInfoProducer
224 - name: infoProducerId
240 - Information Coordinator Service Simulator (exists only in test)
241 operationId: putInfoProducer
243 - name: infoProducerId
254 $ref: '#/components/schemas/producer_registration_info'
263 /actuator/metrics/{requiredMetricName}:
267 summary: Actuator web endpoint 'metrics-requiredMetricName'
268 operationId: metrics-requiredMetricName
270 - name: requiredMetricName
281 application/vnd.spring-boot.actuator.v3+json:
287 application/vnd.spring-boot.actuator.v2+json:
290 /generic_dataproducer/info_job/{infoJobId}:
293 - Producer job control API
294 summary: Callback for Information Job deletion
295 description: The call is invoked to terminate a data subscription. The endpoint
296 is provided by the Information Producer.
297 operationId: jobDeletedCallback
312 $ref: '#/components/schemas/void'
317 summary: Actuator root web endpoint
323 application/vnd.spring-boot.actuator.v3+json:
326 additionalProperties:
328 additionalProperties:
329 $ref: '#/components/schemas/Link'
333 additionalProperties:
335 additionalProperties:
336 $ref: '#/components/schemas/Link'
337 application/vnd.spring-boot.actuator.v2+json:
340 additionalProperties:
342 additionalProperties:
343 $ref: '#/components/schemas/Link'
348 summary: Actuator web endpoint 'logfile'
354 text/plain;charset=UTF-8:
357 /data-consumer/v1/info-jobs/{infoJobId}:
360 - Information Coordinator Service Simulator (exists only in test)
361 operationId: putIndividualInfoJob
374 $ref: '#/components/schemas/consumer_job'
383 /actuator/loggers/{name}:
387 summary: Actuator web endpoint 'loggers-name'
388 operationId: loggers-name
401 application/vnd.spring-boot.actuator.v3+json:
407 application/vnd.spring-boot.actuator.v2+json:
413 summary: Actuator web endpoint 'loggers-name'
414 operationId: loggers-name_2
447 summary: Actuator web endpoint 'health'
453 application/vnd.spring-boot.actuator.v3+json:
459 application/vnd.spring-boot.actuator.v2+json:
466 summary: Actuator web endpoint 'metrics'
472 application/vnd.spring-boot.actuator.v3+json:
478 application/vnd.spring-boot.actuator.v2+json:
485 summary: Actuator web endpoint 'heapdump'
486 operationId: heapdump
491 application/octet-stream:
496 producer_info_job_request:
503 description: The owner of the job
506 description: The time when the job was last updated or created (ISO-8601)
509 description: Identity of the Information Job
512 description: Json for the job data
515 description: Type identity for the job
516 description: The body of the Information Producer callbacks for Information
517 Job creation and deletion
523 description: ' A human-readable explanation specific to this occurrence
525 example: Policy type not found
528 description: 'The HTTP status code generated by the origin server for this
529 occurrence of the problem. '
532 description: Problem as defined in https://tools.ietf.org/html/rfc7807
543 description: Information type Idenitifier of the subscription job
546 description: The target URI of the subscribed information
549 description: Identity of the owner of the job
552 description: Information type specific job data
553 status_notification_uri:
555 description: The target of Information subscription job status notifications
556 description: Information for an Information Job
559 description: Void/empty
564 - noOfReceivedObjects
594 description: Statistics information for one job
600 description: Statistics per job
602 $ref: '#/components/schemas/job_statistics'
603 description: Statistics information
604 producer_registration_info:
606 - info_job_callback_url
607 - info_producer_supervision_callback_url
608 - supported_info_types
611 info_producer_supervision_callback_url:
613 description: callback for producer supervision
614 supported_info_types:
616 description: Supported Information Type IDs
619 description: Supported Information Type IDs
620 info_job_callback_url:
622 description: callback for Information Job
623 description: Information for an Information Producer
631 producer_info_type_info:
633 - info_job_data_schema
634 - info_type_information
637 info_type_information:
639 description: Type specific information for the information type
640 info_job_data_schema:
642 description: Json schema for the job data
643 description: Information for an Information Type