Microservice Documentation Template

• High level description of the service
• What is this service supposed to do?

Dependencies

• What other toolkits / libraries this service depends on? couple words of how im deal with

Expected Input

Subscription Topic 1

* description of topic 1
* input json schema

Subscription Topic 2

* description of topic 2
* input json schema

Output

Publish Topic 1

* description of topic 1
* input json schema

Publish Topic 2

* description of topic 2
* input json schema

Build

• How to build the service at the command line

Execute

• How to execute the service at the command line

Setting up for Development

• How to set up project in Streams Studio

Debug and Problem Determination

• if it is available

Sample

• Sample to use if it's avaible