3 title: Generic Dmaap Information Producer
4 description: Reads data from DMAAP and sends it further to information consumers
6 name: Copyright (C) 2021 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/
18 /dmaap_dataproducer/info_job:
21 - Producer job control API
23 description: Returns all info jobs, can be used for trouble shooting
27 description: Information jobs
33 $ref: '#/components/schemas/producer_info_job_request'
36 - Producer job control API
37 summary: Callback for Information Job creation/modification
38 description: The call is invoked to activate or to modify a data subscription.
39 The endpoint is provided by the Information Producer.
40 operationId: jobCreatedCallback
53 $ref: '#/components/schemas/void'
55 description: Other error in the request
59 $ref: '#/components/schemas/error_information'
61 description: Information type is not found
65 $ref: '#/components/schemas/error_information'
66 /dmaap_dataproducer/health_check:
69 - Producer job control API
70 summary: Producer supervision
71 description: The endpoint is provided by the Information Producer and is used
72 for supervision of the producer.
73 operationId: producerSupervision
76 description: The producer is OK
85 summary: Actuator web endpoint 'threaddump'
86 operationId: handle_2_1_3
98 summary: Actuator web endpoint 'info'
107 /data-producer/v1/info-types/{infoTypeId}:
110 - Information Coordinator Service Simulator (exists only in test)
111 operationId: putInfoType
124 $ref: '#/components/schemas/producer_info_type_info'
137 summary: Actuator web endpoint 'loggers'
138 operationId: handle_6
150 summary: Actuator web endpoint 'health-path'
151 operationId: handle_12
159 /data-producer/v1/info-producers/{infoProducerId}:
162 - Information Coordinator Service Simulator (exists only in test)
163 operationId: getInfoProducer
165 - name: infoProducerId
181 - Information Coordinator Service Simulator (exists only in test)
182 operationId: putInfoProducer
184 - name: infoProducerId
195 $ref: '#/components/schemas/producer_registration_info'
204 /actuator/metrics/{requiredMetricName}:
208 summary: Actuator web endpoint 'metrics-requiredMetricName'
209 operationId: handle_5
211 - name: requiredMetricName
229 summary: Actuator root web endpoint
238 additionalProperties:
240 additionalProperties:
241 $ref: '#/components/schemas/Link'
246 summary: Actuator web endpoint 'logfile'
247 operationId: handle_8
255 /actuator/loggers/{name}:
259 summary: Actuator web endpoint 'loggers-name'
260 operationId: handle_7
279 summary: Actuator web endpoint 'loggers-name'
280 operationId: handle_0
296 /dmaap_dataproducer/info_job/{infoJobId}:
299 - Producer job control API
300 summary: Callback for Information Job deletion
301 description: The call is invoked to terminate a data subscription. The endpoint
302 is provided by the Information Producer.
303 operationId: jobDeletedCallback
318 $ref: '#/components/schemas/void'
323 summary: Actuator web endpoint 'health'
324 operationId: handle_11
335 - Test Consumer Simulator (exists only in test)
336 summary: Consume data
337 description: The call is invoked to push data to consumer
338 operationId: postData
351 $ref: '#/components/schemas/void'
355 - DMAAP Simulator (exists only in test)
356 summary: GET from topic
357 description: The call is invoked to activate or to modify a data subscription.
358 The endpoint is provided by the Information Producer.
359 operationId: getFromTopic
366 $ref: '#/components/schemas/void'
371 summary: Actuator web endpoint 'metrics'
372 operationId: handle_4
384 summary: Actuator web endpoint 'heapdump'
385 operationId: handle_10
395 producer_info_job_request:
402 description: The owner of the job
405 description: The time when the job was last updated or created (ISO-8601)
408 description: Identity of the Information Job
411 description: URI for the target of the produced Information
414 description: Json for the job data
417 description: Type identity for the job
418 description: The body of the Information Producer callbacks for Information
419 Job creation and deletion
425 description: ' A human-readable explanation specific to this occurrence
427 example: Policy type not found
430 description: 'The HTTP status code generated by the origin server for this
431 occurrence of the problem. '
434 description: Problem as defined in https://tools.ietf.org/html/rfc7807
437 description: Void/empty
438 producer_registration_info:
440 - info_job_callback_url
441 - info_producer_supervision_callback_url
442 - supported_info_types
445 info_producer_supervision_callback_url:
447 description: callback for producer supervision
448 supported_info_types:
450 description: Supported Information Type IDs
453 description: Supported Information Type IDs
454 info_job_callback_url:
456 description: callback for Information Job
457 description: Information for an Information Producer
465 producer_info_type_info:
467 - info_job_data_schema
468 - info_type_information
471 info_type_information:
473 description: Type specific information for the information type
474 info_job_data_schema:
476 description: Json schema for the job data
477 description: Information for an Information Type