Skip to content

Commit

Permalink
chore: format
Browse files Browse the repository at this point in the history
  • Loading branch information
esoubiran-aneo committed Sep 21, 2022
1 parent 4e55748 commit 49c1c8c
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 43 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.proto text eol=lf
32 changes: 16 additions & 16 deletions Protos/V1/sessions_common.proto
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import "session_status.proto";

option csharp_namespace = "ArmoniK.Api.gRPC.V1.Sessions";

/**
* A raw session object
/**
* A raw session object
*/
message SessionRaw {
string session_id = 1;
Expand All @@ -21,8 +21,8 @@ message SessionRaw {
google.protobuf.Timestamp cancelled_at = 6;
}

/**
* A session object
/**
* A session object
*/
message SessionSummary {
string session_id = 1;
Expand All @@ -32,8 +32,8 @@ message SessionSummary {
google.protobuf.Timestamp cancelled_at = 4;
}

/**
* Request for listing sessions
/**
* Request for listing sessions
*/
message ListSessionsRequest {
// Page number
Expand Down Expand Up @@ -94,8 +94,8 @@ message ListSessionsRequest {
Sort sort = 4;
}

/**
* Response for listing sessions
/**
* Response for listing sessions
*/
message ListSessionsResponse {
// List of sessions
Expand All @@ -109,29 +109,29 @@ message ListSessionsResponse {
int32 total_count = 4;
}

/**
* Request for getting a session
/**
* Request for getting a session
*/
message GetSessionRequest {
string session_id = 1;
}

/**
* Response for getting a session
/**
* Response for getting a session
*/
message GetSessionResponse {
SessionRaw session = 1;
}

/**
* Request for cancelling a session
/**
* Request for cancelling a session
*/
message CancelSessionRequest {
string session_id = 1;
}

/**
* Response for cancelling a session
/**
* Response for cancelling a session
*/
message CancelSessionResponse {
SessionRaw session = 1;
Expand Down
30 changes: 15 additions & 15 deletions Protos/V1/submitter_common.proto
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ message CreateSessionRequest {
repeated string partition_ids = 2;
}

/*
Reply after session creation.
We have this reply in case of success.
When the session creation is not successful, there is an rpc exception.
/*
Reply after session creation.
We have this reply in case of success.
When the session creation is not successful, there is an rpc exception.
*/
message CreateSessionReply {
// Session id of the created session if successful
Expand Down Expand Up @@ -152,12 +152,12 @@ message WaitRequest {
bool stop_on_first_task_cancellation = 3;
}

/**
* Request to watch result states
* It contains the list of result ids you want to watch
* and some options to filter out some events.
* Chunking is achieved by sending multiple messages with different result ids.
* It is the responsability of the client to chunk the messages properly and avoid messages too large.
/**
* Request to watch result states
* It contains the list of result ids you want to watch
* and some options to filter out some events.
* Chunking is achieved by sending multiple messages with different result ids.
* It is the responsability of the client to chunk the messages properly and avoid messages too large.
*/
message WatchResultRequest {
// list of statuses to check results against for the initial fetch
Expand All @@ -168,11 +168,11 @@ message WatchResultRequest {
repeated string result_ids = 3;
}

/**
* List of Result statuses
* Result Ids are grouped by status. One message contains result Ids that have the same status.
* Chunking is achieved by receiving several messages with the same status and the list of ids in multiple parts.
* As chunking is implicit, there is no way to distinguish between chunked messages and actually separate messages.
/**
* List of Result statuses
* Result Ids are grouped by status. One message contains result Ids that have the same status.
* Chunking is achieved by receiving several messages with the same status and the list of ids in multiple parts.
* As chunking is implicit, there is no way to distinguish between chunked messages and actually separate messages.
*/
message WatchResultStream {
// Status of the results
Expand Down
24 changes: 12 additions & 12 deletions Protos/V1/tasks_common.proto
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import "task_status.proto";

option csharp_namespace = "Armonik.Api.gRPC.V1.Tasks";

/**
* A raw task object
/**
* A raw task object
*/
message TaskRaw {
string id = 1;
Expand Down Expand Up @@ -40,8 +40,8 @@ message TaskRaw {
Output output = 16;
}

/**
* A task object
/**
* A task object
*/
message Task {
string id = 1;
Expand All @@ -54,8 +54,8 @@ message Task {
google.protobuf.Timestamp ended_at = 7;
}

/**
* Request for listing tasks
/**
* Request for listing tasks
*/
message ListTasksRequest {
// Page number
Expand Down Expand Up @@ -118,8 +118,8 @@ message ListTasksRequest {
Sort sort = 4;
}

/**
* Response for listing tasks
/**
* Response for listing tasks
*/
message ListTasksResponse {
// List of tasks
Expand All @@ -133,16 +133,16 @@ message ListTasksResponse {
int32 total = 4;
}

/**
* Request for getting a task
/**
* Request for getting a task
*/
message GetTaskRequest {
// Id of the task
string id = 1;
}

/**
* Response for getting a task
/**
* Response for getting a task
*/
message GetTaskResponse {
// A raw task object
Expand Down

0 comments on commit 49c1c8c

Please sign in to comment.