Updated API Documentation (markdown)

Pascal Precht 2020-02-20 14:26:34 +01:00
parent 73673ffc40
commit 2c6a0bd6a0
1 changed files with 47 additions and 1 deletions

@ -20,7 +20,7 @@
* [deployment](#deployment)
* embarkjs
* [library-manager](#library-manager)
* namesystem
* [namesystem](#namesystem)
* [pipeline](#embark-pipeline)
* process-logs-api-manager
* [proxy](#proxy)
@ -132,6 +132,52 @@ description: actions run when a response is returned from the blockchain node. I
**description**: Disables api server log output
**params**:
### namesystem
module type: stack component
#### API
##### requests
name: `namesystem:node:register`
arguments:
* `name` - `string` - Provider name for node to be registered
* `startFunction` - `function` - Function to boot up node to be registered
* `executeCommand` - `function` - Generic function to delegate commands such as `resolve`, `lookup` etc
Registers a node with the Embark namesystem
name: `namesystem:node:start`
arguments:
* `namesystemConfig` - `NamesystemConfig` - Namesystem configuration object
* `callback` - `function` - A callback function to be called once the node is started
Starts a namesystem node.
name: `namesystem:resolve`
arguments:
* `name` - `string` - Name to be resolved.
Resolves a name based on the nodes registrar.
name: `namesystem:lookup`
arguments:
* `address` - `string` - Address to be looked p
Looks up and address based on the nodes registrar
name: `namesystem:registerSubdomain`
arguments:
* `name` - `string` - Subdomain name
* `address` - `string` - Subdomain address to map to
Registers a subdomain with the nodes registrar using `name` and `address`.
name: `module:namesystem:reset`
Resets the nodes registrar
### blockchain
module type: stack component