From 2b762a4a4408de634d86b7bd56c514b1a84e47e2 Mon Sep 17 00:00:00 2001
From: Joscha Schmiedt <joscha@schmiedt.dev>
Date: Tue, 18 Mar 2025 20:26:24 +0100
Subject: [PATCH] Add comments to scripting.proto file
---
proto/caosdb/scripting/v1alpha1/scripting.proto | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/proto/caosdb/scripting/v1alpha1/scripting.proto b/proto/caosdb/scripting/v1alpha1/scripting.proto
index 311dd7e..7242f3e 100644
--- a/proto/caosdb/scripting/v1alpha1/scripting.proto
+++ b/proto/caosdb/scripting/v1alpha1/scripting.proto
@@ -26,6 +26,7 @@ import "google/protobuf/timestamp.proto";
option java_multiple_files = true;
option java_package = "org.caosdb.api.scripting.v1alpha1";
+// A named argument for a script
message NamedArgument {
// The name of the argument
string name = 1;
@@ -33,6 +34,7 @@ message NamedArgument {
string value = 2;
}
+// Request to execute a script on the server side
message ExecuteServerSideScriptRequest {
// The script to execute
string script_filename = 1;
@@ -50,6 +52,7 @@ message ExecuteServerSideScriptRequest {
bool run_async = 7;
}
+// The result of a script execution
enum ServerSideScriptExecutionResult {
// The result of the script execution is unspecified
SERVER_SIDE_SCRIPT_EXECUTION_RESULT_UNSPECIFIED = 0;
@@ -75,12 +78,13 @@ enum ServerSideScriptExecutionResult {
SERVER_SIDE_SCRIPT_EXECUTION_RESULT_RUNNING = 10;
}
-// IDEA: Give the script execution an id to be able to track it
+// Id of a script execution. This is reserved for later releases to track and manage script executions.
message ServerSideScriptExecutionId {
// Id of the script execution
string script_execution_id = 1;
}
+// Response to a script execution request
message ExecuteServerSideScriptResponse {
// Id of the script execution
ServerSideScriptExecutionId script_execution_id = 1;
@@ -102,6 +106,7 @@ message ExecuteServerSideScriptResponse {
int64 duration_ms = 9;
}
+// Service for server-side scripting
service ServerSideScriptingService {
// Executes a script on the server side
rpc ExecuteServerSideScript(ExecuteServerSideScriptRequest) returns (ExecuteServerSideScriptResponse) {}
--
GitLab