Declared Command
DeclaredCommand is a command a Channel declares: its name and signature, and the Channel and Space that declare it. A command declared by two Channels in a Space is listed twice, and a run of it has to name one.
Operations
| Method | Endpoint | Description |
|---|---|---|
GET |
/command |
List the commands declared across the Organization |
GET |
/space/{space_id}/command |
List the commands runnable in the Space |
List the commands declared across the Organization
GET /command
Operation ID: ListAllCommands
Parameters
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
command |
string | List only the Channels declaring this command. |
Responses
| Status | Description | Content-Type | Schema |
|---|---|---|---|
| 200 | OK | application/json |
Array of DeclaredCommand |
| 400 | DeclaredCommand request is invalid (Bad Request). | application/json |
StandardErrorResponse |
| 401 | Unauthorized access. | application/json |
StandardErrorResponse |
| 403 | Forbidden access. | application/json |
StandardErrorResponse |
| 404 | DeclaredCommand not found. | application/json |
StandardErrorResponse |
| 500 | Something went wrong while processing DeclaredCommand. | application/json |
StandardErrorResponse |
| default | Unexpected error. | application/json |
StandardErrorResponse |
List the commands runnable in the Space
GET /space/{space_id}/command
The commands the Space's Channels declare, with each one's signature and the Channel that declares it.
Operation ID: ListCommands
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
space_id |
string | ✓ | Unique identifier for a space_id |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
command |
string | List only the Channels declaring this command. |
Responses
| Status | Description | Content-Type | Schema |
|---|---|---|---|
| 200 | OK | application/json |
Array of DeclaredCommand |
| 400 | DeclaredCommand request is invalid (Bad Request). | application/json |
StandardErrorResponse |
| 401 | Unauthorized access. | application/json |
StandardErrorResponse |
| 403 | Forbidden access. | application/json |
StandardErrorResponse |
| 404 | DeclaredCommand not found. | application/json |
StandardErrorResponse |
| 500 | Something went wrong while processing DeclaredCommand. | application/json |
StandardErrorResponse |
| default | Unexpected error. | application/json |
StandardErrorResponse |
Schemas
DeclaredCommand
DeclaredCommand is a command a Channel declares: its name and signature, and the Channel and Space that declare it. A command declared by two Channels in a Space is listed twice, and a run of it has to name one.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
ChannelID |
string (uuid) | ||
ChannelSlug |
string | ||
Command |
string | ||
Signature |
CommandSignature |
||
SpaceID |
string (uuid) | ||
SpaceSlug |
string |
StandardErrorResponse
The body of an error response: the error as data (Error), and as one string (message) for clients written before Error.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
Error |
The error: its message, category (Type), HTTP status, details, and structured items. | ||
message |
string | The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error. |