Dependencies
When a driver is loaded into Engine, it becomes a dependency. Dependencies are available as the blueprint from which modules are created. The /dependencies
endpoint provide methods to discover, load and update these. For more on the role the drivers play, see:
Model
Attribute | Type | Description |
id |
| The dependency's unique ID. |
name |
| Human readable name for the dependency. |
class_name |
| The Ruby class name of the driver. |
module_name |
| The kind of module this instantiates (e.g. |
role |
| One of |
description |
| Additional information that describes the dependency. |
default |
| A URL or port number that is typical for modules using this. |
ignore_connected |
| Default state of connectivity monitoring for instances. |
settings |
| A JSON object containing configuration shared by all instances. |
created_at |
| Timestamp of creation. |
Search
GET
https://example.com/api/control/dependencies
List or search for loaded dependencies.
Query Parameters
Name | Type | Description |
---|---|---|
q | string | A search filter to apply. |
limit | integer | (default 20) Max results to return. |
offset | integer | The offset within the result set. |
role | string | Filter to a specific role. |
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Operator | Action | |
| Matches both terms. | |
` | ` | Matches either terms. |
| Negates a single token. | |
| Wraps tokens to form a phrase. | |
| Provide precedence. | |
| Specifies edit distance (fuzziness) after a word. | |
| Specifies slop amount (deviation) after a phrase. |
Management
Create
POST
https://example.com/api/control/dependencies
Defines a new dependency. The driver this references must be available on the engine nodes running this instance of Engine. Available drivers can be listed by using the discovery endpoint.
Request Body
Name | Type | Description |
---|---|---|
name | string | |
class_name | string | |
module_name | string | |
role | string | |
description | string | |
default | string | |
ignore_connected | boolean | |
settings | object |
Retrieve
GET
https://example.com/api/control/dependencies/{id}
Gets dependency information
Path Parameters
Name | Type | Description |
---|---|---|
id | string | ID of the dependency to retrieve. |
Update
PUT
https://example.com/api/control/dependencies/{id}
Updates dependency metadata.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | ID of the dependency to update.i |
Request Body
Name | Type | Description |
---|---|---|
name | string | |
class_name | string | |
module_name | string | |
role | string | |
description | string | |
default | string | |
ignore_connected | boolean | |
settings | object |
Delete
DELETE
https://example.com/api/control/dependencies/{id}
Unloads a driver.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | ID of the dependency to remove. |
Interaction
Reload
POST
https://example.com/api/control/dependencies/{id}/reload
Live reloads the latest version of the driver code and updates all modules using this.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | ID of the dependency to reload. |
Last updated