DMaaP Message Router API 4.0.0 (via swagger2doc)

Topic

POST /topics/create

Create a Topic

  • Description: AAF Permissions required to create authenticated topics: org.onap.dmaap.mr.topicFactory|:org.onap.dmaap.mr.topic:org.onap.dmaap.mr|create

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

Topic details

Responses

200 - successful operation

401 - unauthorized

403 - forbidden

409 - topic already exist

500 - failed to create a topic

GET /topics

Get all topics

  • Description:

  • Produces: [‘application/json’]

Responses

200 - successful operation

500 - failed to return the topics

GET /topics/{topicName}

Get individual topic details

  • Description:

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

topicName

path

topicName

string

Responses

200 - successful operation

404 - topic not found

500 - failed to return the topics

GET /topics/listAll

Get all topics list with details

  • Description:

  • Produces: [‘application/json’]

Responses

200 - successful operation

500 - failed to return the topics

GET /events/{topic}/{consumergroup}/{consumerid}

Get events from a topic

  • 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

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

topic

path

topic name

string

consumergroup

path

consumer group

string

consumerid

path

consumer id

string

limit

query

limit on the number of messages returned

string

timeout

query

amount of time in ms server will open the connection with the Kafka while reading the messages

string

Responses

200 - successful operation

401 - unauthorized

403 - forbidden

409 - unable to read the messages from the topic

429 - Client is making too many requests. Decrease the number of requests to avoid empty response

500 - internal server error

POST /events/{topic}/

Post events to a topic

  • 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

  • Consumes: [‘application/json’, ‘text/plain’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

topic

path

topic name

string

partitionKey

query

topic partitionkey

string

body

body

mesage/s to publish to a topic

Responses

200 - successful operation

400 - Invalid request

401 - unauthorized

403 - forbidden

404 - error while publishing to the topic

500 - internal server error

MirrorMaker

POST /mirrormakers/create

Create a Mirror Maker process and returns the all mirror maker processes

  • Description: AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

Create Mirror Maker

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available

POST /mirrormakers/update

Update a Mirror Maker process and returns the all mirror maker processes

  • Description: AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

Update Mirror Maker

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available

POST /mirrormakers/listAll

List of mirror maker processes

  • Description: AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

List all Mirror Maker processes

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available

POST /mirrormakers/delete

Delete a mirror maker process and return the all mirror maker processes

  • Description: AAF Permissions required: org.onap.dmaap.mr.mirrormaker|*|admin

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

Delete a Mirror Maker process

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available

MirrorMaker Whitelist

POST /mirrormakers/createwhitelist

Add a new topic to a mirror maker whitelist and return all the mirror maker processes

  • 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

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

Add a topic to whitelist

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available

POST /mirrormakers/listallwhitelist

List all whitelist

  • 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

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

List all whitelist

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available

POST /mirrormakers/deletewhitelist

Delate a whitelist and returns the all lirror maker processes

  • 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

  • Consumes: [‘application/json’]

  • Produces: [‘application/json’]

Parameters

Name

Position

Description

Type

body

body

List all whitelist

Responses

200 - successful operation

400 - invalid request

401 - unauthorized

403 - forbidden

503 - list mirror maker not available