From 26518815d133eea469d058a5fc0ea3dda1e9add6 Mon Sep 17 00:00:00 2001 From: lfbrehm <97600985+lfbrehm@users.noreply.github.com> Date: Fri, 29 Sep 2023 10:20:33 +0200 Subject: [PATCH 01/14] fix: Typos and removed result objects --- aruna/api/hooks/services/v2/hooks_service.proto | 6 +++--- aruna/api/storage/services/v2/workspace_service.proto | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/aruna/api/hooks/services/v2/hooks_service.proto b/aruna/api/hooks/services/v2/hooks_service.proto index 11bad2cf..918ff70e 100644 --- a/aruna/api/hooks/services/v2/hooks_service.proto +++ b/aruna/api/hooks/services/v2/hooks_service.proto @@ -71,9 +71,8 @@ message ExternalHook { Credentials credentials = 2; // If empty a basic JSON template will be used optional string custom_template = 3; - // Optional Project/Collection/Dataset where hooks can upload results. - optional string result_object = 4; Method method = 5; + // TODO: Optional request headers } enum Method { @@ -155,7 +154,8 @@ message ListProjectHooksRequest{ } message ListOwnedHooksRequest{ - string user_id = 1; + // ADMIN only + optional string user_id = 1; } message HookInfo { diff --git a/aruna/api/storage/services/v2/workspace_service.proto b/aruna/api/storage/services/v2/workspace_service.proto index 0156148a..725b4353 100644 --- a/aruna/api/storage/services/v2/workspace_service.proto +++ b/aruna/api/storage/services/v2/workspace_service.proto @@ -125,7 +125,7 @@ message GetWorkspaceTemplateRequest { string template_id = 1; } message GetWorkspaceTemplateResponse { - WorkspaceInfo workspaces = 1; + WorkspaceInfo workspace = 1; } message DeleteWorkspaceTemplateRequest { string template_id = 1; From 69514d15a65c910e39bd8a5366ac5fe33bcbb8e6 Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 29 Sep 2023 10:28:05 +0200 Subject: [PATCH 02/14] refactor: Correct AcknowledgePersonalNotificationsRequest --- aruna/api/storage/services/v2/user_service.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aruna/api/storage/services/v2/user_service.proto b/aruna/api/storage/services/v2/user_service.proto index e2b6e4b5..0528a37c 100644 --- a/aruna/api/storage/services/v2/user_service.proto +++ b/aruna/api/storage/services/v2/user_service.proto @@ -404,7 +404,7 @@ message GetPersonalNotificationsResponse { } message AcknowledgePersonalNotificationsRequest { - repeated string notification_id = 1; + repeated string notification_ids = 1; } message AcknowledgePersonalNotificationsResponse {} From b7952523f1ef871c6eaeab15f8e0e191884a0b0b Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 29 Sep 2023 10:29:11 +0200 Subject: [PATCH 03/14] feat: Extend PersonalNotificationVariant Add the option for personal notification in case of permission update. --- aruna/api/storage/services/v2/user_service.proto | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/aruna/api/storage/services/v2/user_service.proto b/aruna/api/storage/services/v2/user_service.proto index 0528a37c..fa143bb4 100644 --- a/aruna/api/storage/services/v2/user_service.proto +++ b/aruna/api/storage/services/v2/user_service.proto @@ -417,7 +417,7 @@ enum ReferenceType { message References { ReferenceType ref_type = 1; - string ref_name = 2; // "User A" + string ref_name = 2; // "User A" | file.txt string ref_value = 3; // 0123AAA123AAA (id) } @@ -426,7 +426,8 @@ enum PersonalNotificationVariant { PERSONAL_NOTIFICATION_VARIANT_ACCESS_REQUESTED = 1; PERSONAL_NOTIFICATION_VARIANT_PERMISSION_GRANTED = 2; PERSONAL_NOTIFICATION_VARIANT_PERMISSION_REVOKED = 3; - PERSONAL_NOTIFICATION_VARIANT_ANNOUNCEMENT = 4; + PERSONAL_NOTIFICATION_VARIANT_PERMISSION_UPDATED = 4; + PERSONAL_NOTIFICATION_VARIANT_ANNOUNCEMENT = 5; } message PersonalNotification { From b8b27d76a84116c99e1a328e60d072e50bf8c163 Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 29 Sep 2023 11:22:23 +0200 Subject: [PATCH 04/14] feat: Extend RequestResourceAccessRequest Adds field for a custom message which can be used to describe the reason the user wants access to the resource. --- aruna/api/storage/services/v2/search_service.proto | 1 + 1 file changed, 1 insertion(+) diff --git a/aruna/api/storage/services/v2/search_service.proto b/aruna/api/storage/services/v2/search_service.proto index 73a02bcd..e02fe9f0 100644 --- a/aruna/api/storage/services/v2/search_service.proto +++ b/aruna/api/storage/services/v2/search_service.proto @@ -98,6 +98,7 @@ message GetResourcesResponse { message RequestResourceAccessRequest { string resource_id = 1; + string message = 2; } From 09cfcf8d5b0fcc461f54cc096289ada528b933aa Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 29 Sep 2023 12:41:34 +0200 Subject: [PATCH 05/14] refactor: GetPersonalNotificationsRequest Remove user_id parameter as the user id will be extracted from the authorization token. --- aruna/api/storage/services/v2/user_service.proto | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/aruna/api/storage/services/v2/user_service.proto b/aruna/api/storage/services/v2/user_service.proto index fa143bb4..288341ac 100644 --- a/aruna/api/storage/services/v2/user_service.proto +++ b/aruna/api/storage/services/v2/user_service.proto @@ -395,9 +395,7 @@ message GetDataproxyTokenUserResponse { string token = 1; } -message GetPersonalNotificationsRequest { - string user_id = 1; -} +message GetPersonalNotificationsRequest {} message GetPersonalNotificationsResponse { repeated PersonalNotification notifications = 1; From 51fb4e43f9ec443adb924b90ad3c50b1c0b6413c Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 29 Sep 2023 15:32:43 +0200 Subject: [PATCH 06/14] refactor: Make References singular --- aruna/api/storage/services/v2/user_service.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/aruna/api/storage/services/v2/user_service.proto b/aruna/api/storage/services/v2/user_service.proto index 288341ac..59fbbfc0 100644 --- a/aruna/api/storage/services/v2/user_service.proto +++ b/aruna/api/storage/services/v2/user_service.proto @@ -413,7 +413,7 @@ enum ReferenceType { REFERENCE_TYPE_RESOURCE = 2; } -message References { +message Reference { ReferenceType ref_type = 1; string ref_name = 2; // "User A" | file.txt string ref_value = 3; // 0123AAA123AAA (id) @@ -432,5 +432,5 @@ message PersonalNotification { string id = 1; PersonalNotificationVariant variant = 2; string message = 3; // User A has requested access for resource B - repeated References refs = 4; // References to resource in the "message" + repeated Reference refs = 4; // References to resource in the "message" } From fee09b036aed86e10d3d7f41bf6d6e256ffa1077 Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Wed, 11 Oct 2023 14:28:24 +0200 Subject: [PATCH 07/14] feat: Extend CreateBundleResponse with id --- aruna/api/dataproxy/services/v2/bundler_service.proto | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/aruna/api/dataproxy/services/v2/bundler_service.proto b/aruna/api/dataproxy/services/v2/bundler_service.proto index 275eff97..3f908a13 100644 --- a/aruna/api/dataproxy/services/v2/bundler_service.proto +++ b/aruna/api/dataproxy/services/v2/bundler_service.proto @@ -33,7 +33,8 @@ message CreateBundleRequest { } message CreateBundleResponse { - string bundle_url = 1; + string bundle_id = 1; + string bundle_url = 2; } message DeleteBundleRequest{ From 4160f6060ca7d6548c40026dadb60fcfc4a16fe8 Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 19:59:21 +0200 Subject: [PATCH 08/14] fix: Remove project_id from AddProjectsToHook rpc url --- aruna/api/hooks/services/v2/hooks_service.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aruna/api/hooks/services/v2/hooks_service.proto b/aruna/api/hooks/services/v2/hooks_service.proto index 918ff70e..39a45381 100644 --- a/aruna/api/hooks/services/v2/hooks_service.proto +++ b/aruna/api/hooks/services/v2/hooks_service.proto @@ -24,7 +24,7 @@ service HooksService { } rpc AddProjectsToHook(AddProjectsToHookRequest) returns (AddProjectsToHookResponse) { option (google.api.http) = { - post : "/v2/hook/{hook_id}/{project_id}" + post : "/v2/hook/{hook_id}" body : "*" }; } From 58f23341d774d11339cab73e6336802865644a8b Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 20:00:09 +0200 Subject: [PATCH 09/14] fix: Remove trailing slashes from rpc urls --- aruna/api/storage/services/v2/collection_service.proto | 2 +- aruna/api/storage/services/v2/dataset_service.proto | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/aruna/api/storage/services/v2/collection_service.proto b/aruna/api/storage/services/v2/collection_service.proto index 55764683..7f2ef738 100644 --- a/aruna/api/storage/services/v2/collection_service.proto +++ b/aruna/api/storage/services/v2/collection_service.proto @@ -45,7 +45,7 @@ service CollectionService { // Queries multiple collections by ID rpc GetCollections(GetCollectionsRequest) returns (GetCollectionsResponse) { option (google.api.http) = { - get : "/v2/collections/" + get : "/v2/collections" }; } diff --git a/aruna/api/storage/services/v2/dataset_service.proto b/aruna/api/storage/services/v2/dataset_service.proto index e7c192cc..c8f6b4d9 100644 --- a/aruna/api/storage/services/v2/dataset_service.proto +++ b/aruna/api/storage/services/v2/dataset_service.proto @@ -45,7 +45,7 @@ service DatasetService { // Queries multiple datasets by ID rpc GetDatasets(GetDatasetsRequest) returns (GetDatasetsResponse) { option (google.api.http) = { - get : "/v2/datasets/" + get : "/v2/datasets" }; } From 9deca1e567a072966207176b73da72c46e48afe4 Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 20:02:00 +0200 Subject: [PATCH 10/14] fix: Correct url parameter and rename duplicate endpoint --- aruna/api/storage/services/v2/service_account_service.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aruna/api/storage/services/v2/service_account_service.proto b/aruna/api/storage/services/v2/service_account_service.proto index 0e9e90dc..441995c1 100644 --- a/aruna/api/storage/services/v2/service_account_service.proto +++ b/aruna/api/storage/services/v2/service_account_service.proto @@ -135,7 +135,7 @@ service ServiceAccountService { rpc GetDataproxyTokenSvcAccount(GetDataproxyTokenSvcAccountRequest) returns (GetDataproxyTokenSvcAccountResponse) { option (google.api.http) = { - get : "/v2/user/{svc_account_id}/proxy_token" + get : "/v2/user/{user_id}/svc_proxy_token" }; } } From 23a9ac8c3269be3096dc9515ca5912719458129b Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 20:03:38 +0200 Subject: [PATCH 11/14] fix: Remove deprecated parameter from rpc urls --- aruna/api/storage/services/v2/user_service.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/aruna/api/storage/services/v2/user_service.proto b/aruna/api/storage/services/v2/user_service.proto index 59fbbfc0..c933a587 100644 --- a/aruna/api/storage/services/v2/user_service.proto +++ b/aruna/api/storage/services/v2/user_service.proto @@ -144,7 +144,7 @@ service UserService { rpc UpdateUserDisplayName(UpdateUserDisplayNameRequest) returns (UpdateUserDisplayNameResponse) { option (google.api.http) = { - patch : "/v2/user/{user_id}/display_name" + patch : "/v2/user/display_name" body : "*" }; } @@ -231,7 +231,7 @@ service UserService { rpc AcknowledgePersonalNotifications(AcknowledgePersonalNotificationsRequest) returns (AcknowledgePersonalNotificationsResponse) { option (google.api.http) = { - get : "/v2/user/{user_id}/acknowledge" + get : "/v2/user/acknowledge" }; } From faabf1c219eaec5777ac48a73194b02396681e2c Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 20:04:52 +0200 Subject: [PATCH 12/14] fix: Remove body from get rpcs --- aruna/api/storage/services/v2/workspace_service.proto | 2 -- 1 file changed, 2 deletions(-) diff --git a/aruna/api/storage/services/v2/workspace_service.proto b/aruna/api/storage/services/v2/workspace_service.proto index 725b4353..17c229c7 100644 --- a/aruna/api/storage/services/v2/workspace_service.proto +++ b/aruna/api/storage/services/v2/workspace_service.proto @@ -31,7 +31,6 @@ service WorkspaceService { returns (GetWorkspaceTemplateResponse) { option (google.api.http) = { get: "/v2/workspace/template/{template_id}" - body : "*" }; } // ListOwnedWorkspaceTemplates @@ -43,7 +42,6 @@ service WorkspaceService { returns (ListOwnedWorkspaceTemplatesResponse) { option (google.api.http) = { get: "/v2/workspace/template" - body : "*" }; } // DeleteWorkspaceTemplates From 2dcfe4395825d2a392735e89e3edc9463bd1d5bb Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 21:13:23 +0200 Subject: [PATCH 13/14] fix: Remove deprecated user_id parameter from rpc url --- aruna/api/storage/services/v2/user_service.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aruna/api/storage/services/v2/user_service.proto b/aruna/api/storage/services/v2/user_service.proto index c933a587..1ec4c7a7 100644 --- a/aruna/api/storage/services/v2/user_service.proto +++ b/aruna/api/storage/services/v2/user_service.proto @@ -219,7 +219,7 @@ service UserService { rpc GetPersonalNotifications(GetPersonalNotificationsRequest) returns (GetPersonalNotificationsResponse) { option (google.api.http) = { - get : "/v2/user/{user_id}/notifications" + get : "/v2/user/notifications" }; } From 50ac1e639c7e8b3807b981efed9e94725cf512c3 Mon Sep 17 00:00:00 2001 From: Jannis Hochmuth Date: Fri, 13 Oct 2023 21:46:06 +0200 Subject: [PATCH 14/14] refactor: Remove unnecessary optional keyword --- aruna/api/hooks/services/v2/hooks_service.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aruna/api/hooks/services/v2/hooks_service.proto b/aruna/api/hooks/services/v2/hooks_service.proto index 39a45381..1d2e7216 100644 --- a/aruna/api/hooks/services/v2/hooks_service.proto +++ b/aruna/api/hooks/services/v2/hooks_service.proto @@ -155,7 +155,7 @@ message ListProjectHooksRequest{ message ListOwnedHooksRequest{ // ADMIN only - optional string user_id = 1; + string user_id = 1; } message HookInfo {