3 title: Generic Dmaap and Kafka Information Producer
4 description: Reads data from DMaaP and Kafka and posts it further to information
7 name: Copyright (C) 2021 Nordix Foundation. Licensed under the Apache License.
8 url: http://www.apache.org/licenses/LICENSE-2.0
14 description: Monitor and interact
16 description: Spring Boot Actuator Web API Documentation
17 url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
23 summary: Actuator web endpoint 'threaddump'
24 operationId: handle_2_1_3
36 summary: Actuator web endpoint 'info'
45 /data-producer/v1/info-types/{infoTypeId}:
48 - Information Coordinator Service Simulator (exists only in test)
49 operationId: putInfoType
62 $ref: '#/components/schemas/producer_info_type_info'
71 /generic_dataproducer/health_check:
74 - Producer job control API
75 summary: Producer supervision
76 description: The endpoint is provided by the Information Producer and is used
77 for supervision of the producer.
78 operationId: producerSupervision
81 description: The producer is OK
86 /generic_dataproducer/info_job:
89 - Producer job control API
91 description: Returns all info jobs, can be used for trouble shooting
95 description: Information jobs
101 $ref: '#/components/schemas/producer_info_job_request'
104 - Producer job control API
105 summary: Callback for Information Job creation/modification
106 description: The call is invoked to activate or to modify a data subscription.
107 The endpoint is provided by the Information Producer.
108 operationId: jobCreatedCallback
121 $ref: '#/components/schemas/void'
123 description: Other error in the request
127 $ref: '#/components/schemas/error_information'
129 description: Information type is not found
133 $ref: '#/components/schemas/error_information'
138 summary: Actuator web endpoint 'loggers'
139 operationId: handle_6
151 summary: Actuator web endpoint 'health-path'
152 operationId: handle_12
160 /data-producer/v1/info-producers/{infoProducerId}:
163 - Information Coordinator Service Simulator (exists only in test)
164 operationId: getInfoProducer
166 - name: infoProducerId
182 - Information Coordinator Service Simulator (exists only in test)
183 operationId: putInfoProducer
185 - name: infoProducerId
196 $ref: '#/components/schemas/producer_registration_info'
205 /generic_dataproducer/info_job/{infoJobId}:
208 - Producer job control API
209 summary: Callback for Information Job deletion
210 description: The call is invoked to terminate a data subscription. The endpoint
211 is provided by the Information Producer.
212 operationId: jobDeletedCallback
227 $ref: '#/components/schemas/void'
228 /actuator/metrics/{requiredMetricName}:
232 summary: Actuator web endpoint 'metrics-requiredMetricName'
233 operationId: handle_5
235 - name: requiredMetricName
253 summary: Actuator root web endpoint
262 additionalProperties:
264 additionalProperties:
265 $ref: '#/components/schemas/Link'
270 summary: Actuator web endpoint 'logfile'
271 operationId: handle_8
279 /actuator/loggers/{name}:
283 summary: Actuator web endpoint 'loggers-name'
284 operationId: handle_7
303 summary: Actuator web endpoint 'loggers-name'
304 operationId: handle_0
324 summary: Actuator web endpoint 'health'
325 operationId: handle_11
336 - Test Consumer Simulator (exists only in test)
337 summary: Consume data
338 description: The call is invoked to push data to consumer
339 operationId: postData
352 $ref: '#/components/schemas/void'
356 - DMAAP Simulator (exists only in test)
357 summary: GET from topic
358 description: The call is invoked to activate or to modify a data subscription.
359 The endpoint is provided by the Information Producer.
360 operationId: getFromTopic
367 $ref: '#/components/schemas/void'
372 summary: Actuator web endpoint 'metrics'
373 operationId: handle_4
385 summary: Actuator web endpoint 'heapdump'
386 operationId: handle_10
396 producer_info_job_request:
403 description: The owner of the job
406 description: The time when the job was last updated or created (ISO-8601)
409 description: Identity of the Information Job
412 description: URI for the target of the produced Information
415 description: Json for the job data
418 description: Type identity for the job
419 description: The body of the Information Producer callbacks for Information
420 Job creation and deletion
426 description: ' A human-readable explanation specific to this occurrence
428 example: Policy type not found
431 description: 'The HTTP status code generated by the origin server for this
432 occurrence of the problem. '
435 description: Problem as defined in https://tools.ietf.org/html/rfc7807
438 description: Void/empty
439 producer_registration_info:
441 - info_job_callback_url
442 - info_producer_supervision_callback_url
443 - supported_info_types
446 info_producer_supervision_callback_url:
448 description: callback for producer supervision
449 supported_info_types:
451 description: Supported Information Type IDs
454 description: Supported Information Type IDs
455 info_job_callback_url:
457 description: callback for Information Job
458 description: Information for an Information Producer
466 producer_info_type_info:
468 - info_job_data_schema
469 - info_type_information
472 info_type_information:
474 description: Type specific information for the information type
475 info_job_data_schema:
477 description: Json schema for the job data
478 description: Information for an Information Type