Skip to content

Commit

Permalink
Merge pull request #63 from rgallor/main
Browse files Browse the repository at this point in the history
feat(forwarder): add interfaces to handle a remote terminal session
  • Loading branch information
rbino authored Dec 5, 2023
2 parents eee551c + 173a482 commit c7dfb17
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
16 changes: 16 additions & 0 deletions io.edgehog.devicemanager.ForwarderSessionsState.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"interface_name": "io.edgehog.devicemanager.ForwarderSessionsState",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"description": "This property is set by a device to provide information about the status of a remote terminal session.",
"mappings": [
{
"endpoint": "/%{session_token}/status",
"type": "string",
"description": "Indicates if the device is connecting, connected or disconnected to a remote terminal session.",
"doc": "An enum with the following possible values: Connecting | Connected | Disconnected."
}
]
}
32 changes: 32 additions & 0 deletions io.edgehog.devicemanager.RemoteTerminalRequest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"interface_name": "io.edgehog.devicemanager.RemoteTerminalRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"description": "Configuration to open a remote terminal from a device to a certain host.",
"mappings": [
{
"endpoint": "/request/session_token",
"type": "string",
"database_retention_policy": "use_ttl",
"database_retention_ttl": 31556952,
"description": "The session token thanks to which the device can authenticates itself through Edgehog."
},
{
"endpoint": "/request/port",
"type": "integer",
"database_retention_policy": "use_ttl",
"database_retention_ttl": 31556952,
"description": "The host port the device must connect to."
},
{
"endpoint": "/request/host",
"type": "string",
"database_retention_policy": "use_ttl",
"database_retention_ttl": 31556952,
"description": "The IP address or host name the device must connect to."
}
]
}

0 comments on commit c7dfb17

Please sign in to comment.