Download OpenAPI specification:Download
Waterpipe is programming tool for integrations and aggregation systems.
Golang based scripting allow implement no code solutions for your business.
This API is documented in OpenAPI format. In this document you will found how to create pipes, nodes and tasks.
Pipe is a queue of nodes where each node is a some logic.
Task starting from waterpipe.start node and finalize at waterpipe.final node.
Pipe has multiple versions, when you create new task you need to specify version of pipe directly.
This API allow for you create pipe and versions for him.
| name required | string Name of pipe |
| namespace required | string Similar for directories |
| description | string |
object Some functional that customize via settings |
{- "name": "Test pipe",
- "namespace": "foo.bar.hello",
- "description": "It's test pipe",
- "settings": {
- "debug": false
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}| id required | string <uuid> Pipe id |
| qualifier | string Version name |
Array of objects Can't be empty. Must contains minimum two nodes: waterpipe.start and waterpipe.final |
Minimum pipe definition that can be created
{- "qualifier": "v10101",
- "nodes": [
- {
- "id": "NODE_A",
- "type": "waterpipe.start",
- "next": "NODE_B"
}, - {
- "id": "NODE_B",
- "type": "waterpipe.final",
- "args": {
- "final": "inject:NODE_C"
}
}, - {
- "id": "NODE_C",
- "type": "waterpipe.inject.bool",
- "args": {
- "value": true
}
}
]
}{- "error": "validation error - parameter x missed"
}Node is a minimal logic, similar for a function in programming language.
This API allow for you create nodes and change them.