2 "components": {"schemas": {
3 "producer_info_job_request": {
4 "description": "The body of the Information Producer callbacks for Information Job creation and deletion",
6 "required": ["info_job_identity"],
9 "description": "The owner of the job",
13 "description": "The time when the job was last updated or created (ISO-8601)",
16 "info_job_identity": {
17 "description": "Identity of the Information Job",
21 "description": "URI for the target of the produced Information",
25 "description": "Json for the job data",
28 "info_type_identity": {
29 "description": "Type identity for the job",
34 "error_information": {
35 "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
39 "description": " A human-readable explanation specific to this occurrence of the problem.",
41 "example": "Policy type not found"
45 "description": "The HTTP status code generated by the origin server for this occurrence of the problem. ",
52 "description": "Void/empty",
55 "producer_registration_info": {
56 "description": "Information for an Information Producer",
59 "info_job_callback_url",
60 "info_producer_supervision_callback_url",
61 "supported_info_types"
64 "info_producer_supervision_callback_url": {
65 "description": "callback for producer supervision",
68 "supported_info_types": {
69 "description": "Supported Information Type IDs",
72 "description": "Supported Information Type IDs",
76 "info_job_callback_url": {
77 "description": "callback for Information Job",
85 "templated": {"type": "boolean"},
86 "href": {"type": "string"}
89 "producer_info_type_info": {
90 "description": "Information for an Information Type",
93 "info_job_data_schema",
94 "info_type_information"
97 "info_type_information": {
98 "description": "Type specific information for the information type",
101 "info_job_data_schema": {
102 "description": "Json schema for the job data",
110 "/dmaap_dataproducer/info_job": {
112 "summary": "Callback for Information Job creation/modification",
114 "content": {"application/json": {"schema": {"type": "string"}}},
117 "description": "The call is invoked to activate or to modify a data subscription. The endpoint is provided by the Information Producer.",
118 "operationId": "jobCreatedCallback",
122 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
125 "description": "Other error in the request",
126 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
129 "description": "Information type is not found",
130 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
133 "tags": ["Producer job control API"]
136 "summary": "Get all jobs",
137 "description": "Returns all info jobs, can be used for trouble shooting",
138 "operationId": "getJobs",
139 "responses": {"200": {
140 "description": "Information jobs",
141 "content": {"application/json": {"schema": {
143 "items": {"$ref": "#/components/schemas/producer_info_job_request"}
146 "tags": ["Producer job control API"]
149 "/dmaap_dataproducer/health_check": {"get": {
150 "summary": "Producer supervision",
151 "description": "The endpoint is provided by the Information Producer and is used for supervision of the producer.",
152 "operationId": "producerSupervision",
153 "responses": {"200": {
154 "description": "The producer is OK",
155 "content": {"application/json": {"schema": {"type": "string"}}}
157 "tags": ["Producer job control API"]
159 "/actuator/threaddump": {"get": {
160 "summary": "Actuator web endpoint 'threaddump'",
161 "operationId": "handle_2_1_3",
162 "responses": {"200": {
164 "content": {"*/*": {"schema": {"type": "object"}}}
168 "/actuator/info": {"get": {
169 "summary": "Actuator web endpoint 'info'",
170 "operationId": "handle_9",
171 "responses": {"200": {
173 "content": {"*/*": {"schema": {"type": "object"}}}
177 "/data-producer/v1/info-types/{infoTypeId}": {"put": {
179 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/producer_info_type_info"}}},
182 "operationId": "putInfoType",
183 "responses": {"200": {
185 "content": {"application/json": {"schema": {"type": "object"}}}
188 "schema": {"type": "string"},
190 "name": "infoTypeId",
193 "tags": ["Information Coordinator Service Simulator (exists only in test)"]
195 "/actuator/loggers": {"get": {
196 "summary": "Actuator web endpoint 'loggers'",
197 "operationId": "handle_6",
198 "responses": {"200": {
200 "content": {"*/*": {"schema": {"type": "object"}}}
204 "/actuator/health/**": {"get": {
205 "summary": "Actuator web endpoint 'health-path'",
206 "operationId": "handle_12",
207 "responses": {"200": {
209 "content": {"*/*": {"schema": {"type": "object"}}}
213 "/data-producer/v1/info-producers/{infoProducerId}": {
215 "operationId": "getInfoProducer",
216 "responses": {"200": {
218 "content": {"application/json": {"schema": {"type": "object"}}}
221 "schema": {"type": "string"},
223 "name": "infoProducerId",
226 "tags": ["Information Coordinator Service Simulator (exists only in test)"]
230 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/producer_registration_info"}}},
233 "operationId": "putInfoProducer",
234 "responses": {"200": {
236 "content": {"application/json": {"schema": {"type": "object"}}}
239 "schema": {"type": "string"},
241 "name": "infoProducerId",
244 "tags": ["Information Coordinator Service Simulator (exists only in test)"]
247 "/actuator/metrics/{requiredMetricName}": {"get": {
248 "summary": "Actuator web endpoint 'metrics-requiredMetricName'",
249 "operationId": "handle_5",
250 "responses": {"200": {
252 "content": {"*/*": {"schema": {"type": "object"}}}
255 "schema": {"type": "string"},
257 "name": "requiredMetricName",
262 "/actuator": {"get": {
263 "summary": "Actuator root web endpoint",
264 "operationId": "links_1",
265 "responses": {"200": {
267 "content": {"*/*": {"schema": {
268 "additionalProperties": {
269 "additionalProperties": {"$ref": "#/components/schemas/Link"},
277 "/actuator/logfile": {"get": {
278 "summary": "Actuator web endpoint 'logfile'",
279 "operationId": "handle_8",
280 "responses": {"200": {
282 "content": {"*/*": {"schema": {"type": "object"}}}
286 "/actuator/loggers/{name}": {
288 "summary": "Actuator web endpoint 'loggers-name'",
289 "operationId": "handle_0",
290 "responses": {"200": {
292 "content": {"*/*": {"schema": {"type": "object"}}}
295 "schema": {"type": "string"},
303 "summary": "Actuator web endpoint 'loggers-name'",
304 "operationId": "handle_7",
305 "responses": {"200": {
307 "content": {"*/*": {"schema": {"type": "object"}}}
310 "schema": {"type": "string"},
318 "/dmaap_dataproducer/info_job/{infoJobId}": {"delete": {
319 "summary": "Callback for Information Job deletion",
320 "description": "The call is invoked to terminate a data subscription. The endpoint is provided by the Information Producer.",
321 "operationId": "jobDeletedCallback",
322 "responses": {"200": {
324 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
327 "schema": {"type": "string"},
332 "tags": ["Producer job control API"]
334 "/actuator/health": {"get": {
335 "summary": "Actuator web endpoint 'health'",
336 "operationId": "handle_11",
337 "responses": {"200": {
339 "content": {"*/*": {"schema": {"type": "object"}}}
343 "/consumer": {"post": {
344 "summary": "Consume data",
346 "content": {"application/json": {"schema": {"type": "string"}}},
349 "description": "The call is invoked to push data to consumer",
350 "operationId": "postData",
351 "responses": {"200": {
353 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
355 "tags": ["Test Consumer Simulator (exists only in test)"]
357 "/dmaap-topic-1": {"get": {
358 "summary": "GET from topic",
359 "description": "The call is invoked to activate or to modify a data subscription. The endpoint is provided by the Information Producer.",
360 "operationId": "getFromTopic",
361 "responses": {"200": {
363 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
365 "tags": ["DMAAP Simulator (exists only in test)"]
367 "/actuator/metrics": {"get": {
368 "summary": "Actuator web endpoint 'metrics'",
369 "operationId": "handle_4",
370 "responses": {"200": {
372 "content": {"*/*": {"schema": {"type": "object"}}}
376 "/actuator/heapdump": {"get": {
377 "summary": "Actuator web endpoint 'heapdump'",
378 "operationId": "handle_10",
379 "responses": {"200": {
381 "content": {"*/*": {"schema": {"type": "object"}}}
388 "name": "Copyright (C) 2021 Nordix Foundation. Licensed under the Apache License.",
389 "url": "http://www.apache.org/licenses/LICENSE-2.0"
391 "description": "Reads data from DMAAP and sends it further to information consumers",
392 "title": "Generic Dmaap Information Producer",
397 "description": "Monitor and interact",
399 "description": "Spring Boot Actuator Web API Documentation",
400 "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"