Skip to content

Commit

Permalink
docs: add documentation
Browse files Browse the repository at this point in the history
Add documentation on the grpc calls that were still missing it.
  • Loading branch information
remcowesterhoud committed Feb 21, 2022
1 parent 47adf79 commit f8d7421
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion engine-protocol/src/main/proto/engine_control.proto
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,27 @@ message WaitForIdleStateResponse {}
message GetRecordsRequest {}

message RecordResponse {
// A JSON representation of a Record.
string recordJson = 1;
}

service EngineControl {

/*
Starts the in-memory engine.
*/
rpc StartEngine (StartEngineRequest) returns (StartEngineResponse);

/*
Stops the in-memory engine.
*/
rpc StopEngine (StopEngineRequest) returns (StopEngineResponse);

/*
Resets the in-memory engine. This is done by recreating the engine entirely.
The engine should be reset before executing the next test. This prevents
the tests from influencing each other.
*/
rpc ResetEngine (ResetEngineRequest) returns (ResetEngineResponse);

/*
Expand All @@ -58,7 +70,10 @@ service EngineControl {
*/
rpc WaitForIdleState (WaitForIdleStateRequest) returns (WaitForIdleStateResponse);


/*
Get all records from the in-memory engine. These records will be returned
in a JSON format. Client-side these should be mapped to Records.
*/
rpc GetRecords (GetRecordsRequest) returns (stream RecordResponse);

}

0 comments on commit f8d7421

Please sign in to comment.