4 "description": "DMaaP MR REST API",
6 "title": "DMaaP MR REST API"
8 "host": "message-router:30227",
13 "description": "Operations about topic"
16 "name": "MirrorMaker",
17 "description": "Operations about mirror maker"
20 "name": "MirrorMaker Whitelist",
21 "description": "Operations about mirror maker whitelist"
34 "summary": "Create a Topic",
35 "description": "AAF Permissions required to create authenticated topics: org.onap.dmaap.mr.topicFactory|:org.onap.dmaap.mr.topic:org.onap.dmaap.mr|create ",
36 "operationId": "Create a Topic",
47 "description": "Topic details",
50 "$ref": "#/definitions/createTopic"
56 "description": "successful operation"
59 "description": "unauthorized"
62 "description": "forbidden"
65 "description": "topic already exist"
68 "description": "failed to create a topic"
83 "summary": "Get all topics",
85 "operationId": "view all topics",
91 "description": "successful operation"
94 "description": "failed to return the topics"
99 "/topics/{topicName}": {
104 "summary": "Get individual topic details",
106 "operationId": "view the topic",
114 "description": "topicName",
121 "description": "successful operation"
124 "description": "topic not found"
127 "description": "failed to return the topics"
137 "summary": "Get all topics list with details",
139 "operationId": "view all topics details",
145 "description": "successful operation"
148 "description": "failed to return the topics"
153 "/events/{topic}/{consumergroup}/{consumerid}": {
158 "summary": "Get events from a topic",
159 "description": "Subscribe to a topic. If already subscribed read the events from the topic. Basic Auth header is required for subcribing to a topic. AAF permissions required for subscribing to a authenticated topic: org.onap.dmaap.mr.topic|:topic.<topic name>|sub",
160 "operationId": "subscribe to a topic",
168 "description": "topic name",
173 "name": "consumergroup",
175 "description": "consumer group",
180 "name": "consumerid",
182 "description": "consumer id",
189 "description": "limit on the number of messages returned",
195 "description": "amount of time in ms server will open the connection with the Kafka while reading the messages",
201 "description": "successful operation"
204 "description": "unauthorized"
207 "description": "forbidden"
210 "description": "unable to read the messages from the topic"
213 "description": "Client is making too many requests. Decrease the number of requests to avoid empty response"
216 "description": "internal server error"
226 "/events/{topic}/": {
231 "summary": "Post events to a topic",
232 "description": "post an event to a topic. Basic Auth header is required for subcribing to a topic. AAF permissions required for subscribing to a authenticated topic: org.onap.dmaap.mr.topic|:topic.<topic name>|pub",
233 "operationId": "post messages to a topic",
245 "description": "topic name",
250 "name": "partitionKey",
252 "description": "topic partitionkey",
258 "description": "mesage/s to publish to a topic",
267 "description": "successful operation"
270 "description": "Invalid request"
273 "description": "unauthorized"
276 "description": "forbidden"
279 "description": "error while publishing to the topic"
282 "description": "internal server error"
292 "/mirrormakers/create": {
297 "summary": "Create a Mirror Maker process and returns the all mirror maker processes",
298 "description": "AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin",
299 "operationId": "Create a Mirror Maker process",
310 "description": "Create Mirror Maker",
313 "$ref": "#/definitions/createMirrorMaker"
319 "description": "successful operation"
322 "description": "invalid request"
325 "description": "unauthorized"
328 "description": "forbidden"
331 "description": "list mirror maker not available"
341 "/mirrormakers/update": {
346 "summary": "Update a Mirror Maker process and returns the all mirror maker processes",
347 "description": "AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin",
348 "operationId": "Update a Mirror Maker process",
359 "description": "Update Mirror Maker",
362 "$ref": "#/definitions/updateMirrorMaker"
368 "description": "successful operation"
371 "description": "invalid request"
374 "description": "unauthorized"
377 "description": "forbidden"
380 "description": "list mirror maker not available"
390 "/mirrormakers/listAll": {
395 "summary": "List of mirror maker processes",
396 "description": "AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin",
397 "operationId": "List all Mirror Maker processes",
408 "description": "List all Mirror Maker processes",
411 "$ref": "#/definitions/listAllMirrorMaker"
417 "description": "successful operation"
420 "description": "invalid request"
423 "description": "unauthorized"
426 "description": "forbidden"
429 "description": "list mirror maker not available"
439 "/mirrormakers/delete": {
444 "summary": "Delete a mirror maker process and return the all mirror maker processes",
445 "description": "AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin",
446 "operationId": "Delete a Mirror Maker process",
457 "description": "Delete a Mirror Maker process",
460 "$ref": "#/definitions/deleteMirrorMaker"
466 "description": "successful operation"
469 "description": "invalid request"
472 "description": "unauthorized"
475 "description": "forbidden"
478 "description": "list mirror maker not available"
488 "/mirrormakers/createwhitelist": {
491 "MirrorMaker Whitelist"
493 "summary": "Add a new topic to a mirror maker whitelist and return all the mirror maker processes",
494 "description": "AAF Permissions required: rg.onap.dmaap.mr.mirrormaker|*|user , org.onap.dmaap.mr.topicFactory|:org.onap.dmaap.mr.topic:org.onap.dmaap.mr|create",
495 "operationId": "Create a whitelist",
506 "description": "Add a topic to whitelist",
509 "$ref": "#/definitions/createWhitelist"
515 "description": "successful operation"
518 "description": "invalid request"
521 "description": "unauthorized"
524 "description": "forbidden"
527 "description": "list mirror maker not available"
537 "/mirrormakers/listallwhitelist": {
540 "MirrorMaker Whitelist"
542 "summary": "List all whitelist",
543 "description": "AAF Permissions required: rg.onap.dmaap.mr.mirrormaker|*|user , org.onap.dmaap.mr.topicFactory|:org.onap.dmaap.mr.topic:org.onap.dmaap.mr|create",
544 "operationId": "List all whitelist",
555 "description": "List all whitelist",
558 "$ref": "#/definitions/listallwhitelist"
564 "description": "successful operation"
567 "description": "invalid request"
570 "description": "unauthorized"
573 "description": "forbidden"
576 "description": "list mirror maker not available"
586 "/mirrormakers/deletewhitelist": {
589 "MirrorMaker Whitelist"
591 "summary": "Delate a whitelist and returns the all lirror maker processes ",
592 "description": "AAF Permissions required: rg.onap.dmaap.mr.mirrormaker|*|user , org.onap.dmaap.mr.topicFactory|:org.onap.dmaap.mr.topic:org.onap.dmaap.mr|create",
593 "operationId": "Delete all whitelist",
604 "description": "List all whitelist",
607 "$ref": "#/definitions/listallwhitelist"
613 "description": "successful operation"
616 "description": "invalid request"
619 "description": "unauthorized"
622 "description": "forbidden"
625 "description": "list mirror maker not available"
636 "securityDefinitions": {
647 "example": "org.onap.dmaap.mr.mrtesttopic"
649 "topicDescription": {
651 "example": "test topic"
658 "replicationCount": {
663 "transactionEnabled": {
669 "createMirrorMaker": {
672 "createMirrorMaker": {
673 "$ref": "#/definitions/createMirrorMaker.mirrorMaker"
677 "createMirrorMaker.mirrorMaker": {
682 "description": "Unique Name for the MirrorMaker. A-Z 1-0 only",
683 "example": "centraltoedge"
687 "description": "Consumer hostname/IP Address",
688 "example": "10.12.6.98:30491"
692 "description": "Producer hostname/IP Address",
693 "example": "10.12.5.108:30491"
697 "description": "Number of consumer threads to start. (If not provided default is 1)",
702 "description": "Topic names to be whitelisted. This can be provided later using createWhitelist API",
703 "example": "org.onap.dmaap.mr.mrtesttopic"
707 "description": "Enable error log monitoring on the MirrorMaker thread. Default values is False.If not provided error log is not monitored.",
717 "updateMirrorMaker": {
720 "updateMirrorMaker": {
721 "$ref": "#/definitions/updateMirrorMaker.mirrorMaker"
725 "updateMirrorMaker.mirrorMaker": {
730 "description": "Existing Mirror Maker name",
731 "example": "centraltoedge"
735 "description": "Consumer hostname/IP Address",
736 "example": "10.12.6.98:30491"
740 "description": "Producer hostname/IP Address",
741 "example": "10.12.5.108:30491"
745 "description": "Update number of consumer threads",
750 "description": "Enable/Disable error log monitoring on the MirrorMaker thread",
758 "listAllMirrorMaker": {
761 "listAllMirrorMaker": {
764 "$ref": "#/definitions/listAllMirrorMaker.mirrorMaker"
769 "listAllMirrorMaker.mirrorMaker": {
772 "deleteMirrorMaker": {
775 "deleteMirrorMaker": {
776 "$ref": "#/definitions/deleteMirrorMaker.mirrorMaker"
780 "deleteMirrorMaker.mirrorMaker": {
785 "description": "Existing Mirror Maker name",
786 "example": "centraltoedge2"
798 "description": "Existing Mirror Maker name",
799 "example": "centraltoedge"
804 "example": "org.onap.dmaap.mr"
806 "whitelistTopicName": {
808 "description": "Topic name to add to the whitelist",
809 "example": "org.onap.dmaap.mr.mrtesttopic2"
818 "listallwhitelist": {
823 "description": "Existing Mirror Maker name",
824 "example": "centraltoedge"
829 "example": "org.onap.dmaap.mr"
837 "deleteeWhitelist": {
842 "description": "Existing Mirror Maker name",
843 "example": "centraltoedge"
848 "example": "org.onap.dmaap.mr"
850 "whitelistTopicName": {
852 "description": "Topic name to delete from the whitelist",
853 "example": "org.onap.dmaap.mr.mrtesttopic2"