Skip to content

Commit 2b6ea1a

Browse files
committed
[core] Document IntegratedServices API values
1 parent 5d0d3b5 commit 2b6ea1a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

core/protos/o2control.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -474,13 +474,13 @@ message Empty {
474474
}
475475

476476
message ListIntegratedServicesReply {
477-
map<string, IntegratedServiceInfo> services = 1;
477+
map<string, IntegratedServiceInfo> services = 1; // keys are IDs (e.g. "ddsched"), the service name should be displayed to users instead
478478
}
479479

480480
message IntegratedServiceInfo {
481-
string name = 1;
481+
string name = 1; // user-visible service name, e.g. "DD scheduler"
482482
bool enabled = 2;
483483
string endpoint = 3;
484-
string connectionState = 4;
485-
string data = 5;
484+
string connectionState = 4; // allowed values: READY, CONNECTING, TRANSIENT_FAILURE, IDLE, SHUTDOWN
485+
string data = 5; // always a JSON payload with a map<string, string> inside.
486486
}

0 commit comments

Comments
 (0)