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": "Information type is not found",
126 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
129 "tags": ["Producer job control API"]
132 "summary": "Get all jobs",
133 "description": "Returns all info jobs, can be used for trouble shooting",
134 "operationId": "getJobs",
135 "responses": {"200": {
136 "description": "Information jobs",
137 "content": {"application/json": {"schema": {
139 "items": {"$ref": "#/components/schemas/producer_info_job_request"}
142 "tags": ["Producer job control API"]
145 "/dmaap_dataproducer/health_check": {"get": {
146 "summary": "Producer supervision",
147 "description": "The endpoint is provided by the Information Producer and is used for supervision of the producer.",
148 "operationId": "producerSupervision",
149 "responses": {"200": {
150 "description": "The producer is OK",
151 "content": {"application/json": {"schema": {"type": "string"}}}
153 "tags": ["Producer job control API"]
155 "/actuator/threaddump": {"get": {
156 "summary": "Actuator web endpoint 'threaddump'",
157 "operationId": "handle_2_1_3",
158 "responses": {"200": {
160 "content": {"*/*": {"schema": {"type": "object"}}}
164 "/actuator/info": {"get": {
165 "summary": "Actuator web endpoint 'info'",
166 "operationId": "handle_9",
167 "responses": {"200": {
169 "content": {"*/*": {"schema": {"type": "object"}}}
173 "/data-producer/v1/info-types/{infoTypeId}": {"put": {
175 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/producer_info_type_info"}}},
178 "operationId": "putInfoType",
179 "responses": {"200": {
181 "content": {"application/json": {"schema": {"type": "object"}}}
184 "schema": {"type": "string"},
186 "name": "infoTypeId",
189 "tags": ["Information Coordinator Service Simulator (exists only in test)"]
191 "/actuator/loggers": {"get": {
192 "summary": "Actuator web endpoint 'loggers'",
193 "operationId": "handle_6",
194 "responses": {"200": {
196 "content": {"*/*": {"schema": {"type": "object"}}}
200 "/actuator/health/**": {"get": {
201 "summary": "Actuator web endpoint 'health-path'",
202 "operationId": "handle_12",
203 "responses": {"200": {
205 "content": {"*/*": {"schema": {"type": "object"}}}
209 "/data-producer/v1/info-producers/{infoProducerId}": {
211 "operationId": "getInfoProducer",
212 "responses": {"200": {
214 "content": {"application/json": {"schema": {"type": "object"}}}
217 "schema": {"type": "string"},
219 "name": "infoProducerId",
222 "tags": ["Information Coordinator Service Simulator (exists only in test)"]
226 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/producer_registration_info"}}},
229 "operationId": "putInfoProducer",
230 "responses": {"200": {
232 "content": {"application/json": {"schema": {"type": "object"}}}
235 "schema": {"type": "string"},
237 "name": "infoProducerId",
240 "tags": ["Information Coordinator Service Simulator (exists only in test)"]
243 "/actuator/metrics/{requiredMetricName}": {"get": {
244 "summary": "Actuator web endpoint 'metrics-requiredMetricName'",
245 "operationId": "handle_5",
246 "responses": {"200": {
248 "content": {"*/*": {"schema": {"type": "object"}}}
251 "schema": {"type": "string"},
253 "name": "requiredMetricName",
258 "/actuator": {"get": {
259 "summary": "Actuator root web endpoint",
260 "operationId": "links_1",
261 "responses": {"200": {
263 "content": {"*/*": {"schema": {
264 "additionalProperties": {
265 "additionalProperties": {"$ref": "#/components/schemas/Link"},
273 "/actuator/logfile": {"get": {
274 "summary": "Actuator web endpoint 'logfile'",
275 "operationId": "handle_8",
276 "responses": {"200": {
278 "content": {"*/*": {"schema": {"type": "object"}}}
282 "/actuator/loggers/{name}": {
284 "summary": "Actuator web endpoint 'loggers-name'",
285 "operationId": "handle_0",
286 "responses": {"200": {
288 "content": {"*/*": {"schema": {"type": "object"}}}
291 "schema": {"type": "string"},
299 "summary": "Actuator web endpoint 'loggers-name'",
300 "operationId": "handle_7",
301 "responses": {"200": {
303 "content": {"*/*": {"schema": {"type": "object"}}}
306 "schema": {"type": "string"},
314 "/dmaap_dataproducer/info_job/{infoJobId}": {"delete": {
315 "summary": "Callback for Information Job deletion",
316 "description": "The call is invoked to terminate a data subscription. The endpoint is provided by the Information Producer.",
317 "operationId": "jobDeletedCallback",
318 "responses": {"200": {
320 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
323 "schema": {"type": "string"},
328 "tags": ["Producer job control API"]
330 "/actuator/health": {"get": {
331 "summary": "Actuator web endpoint 'health'",
332 "operationId": "handle_11",
333 "responses": {"200": {
335 "content": {"*/*": {"schema": {"type": "object"}}}
339 "/consumer": {"post": {
340 "summary": "Consume data",
342 "content": {"application/json": {"schema": {"type": "string"}}},
345 "description": "The call is invoked to push data to consumer",
346 "operationId": "postData",
347 "responses": {"200": {
349 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
351 "tags": ["Test Consumer Simulator (exists only in test)"]
353 "/dmaap-topic-1": {"get": {
354 "summary": "GET from topic",
355 "description": "The call is invoked to activate or to modify a data subscription. The endpoint is provided by the Information Producer.",
356 "operationId": "getFromTopic",
357 "responses": {"200": {
359 "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
361 "tags": ["DMAAP Simulator (exists only in test)"]
363 "/actuator/metrics": {"get": {
364 "summary": "Actuator web endpoint 'metrics'",
365 "operationId": "handle_4",
366 "responses": {"200": {
368 "content": {"*/*": {"schema": {"type": "object"}}}
372 "/actuator/heapdump": {"get": {
373 "summary": "Actuator web endpoint 'heapdump'",
374 "operationId": "handle_10",
375 "responses": {"200": {
377 "content": {"*/*": {"schema": {"type": "object"}}}
384 "name": "Copyright (C) 2021 Nordix Foundation. Licensed under the Apache License.",
385 "url": "http://www.apache.org/licenses/LICENSE-2.0"
387 "description": "Reads data from DMAAP and sends it further to information consumers",
388 "title": "Generic Dmaap Information Producer",
393 "description": "Monitor and interact",
395 "description": "Spring Boot Actuator Web API Documentation",
396 "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"