proto: ワークスペース単体取得メソッド パフォーマンス的にも利便性的にも必要だった。

Changes

3 changed files (+51/-0)

• packages/proto/yamori/workspace/v1/get_request.proto (new)
  • @@ -0,0 +1,17 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.workspace.v1; + + import "yamori/workspace/v1/workspace_id.proto"; + import "yamori/workspace/v1/workspace_read_mask.proto"; + + message GetRequest { + // 対象のワークスペースの ID 。 + WorkspaceID workspace_id = 1; + + // GetResponse.ok に対してかけるフィールドマスク。 + WorkspaceReadMask read_mask = 2; + }
• packages/proto/yamori/workspace/v1/get_response.proto (new)
  • @@ -0,0 +1,29 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.workspace.v1; + + import "yamori/error/v1/missing_field_error.proto"; + import "yamori/error/v1/not_found.proto"; + import "yamori/error/v1/system_error.proto"; + import "yamori/workspace/v1/workspace.proto"; + + message GetResponse { + oneof result { + // 対象のワークスペース。 + Workspace ok = 1; + + // システムエラーが発生したため取得処理が中断された。 + yamori.error.v1.SystemError system_error = 2; + + // 対象のワークスペースが見つからない。 + // - ID がおかしい + // - 既に削除された + yamori.error.v1.NotFound not_found = 3; + + // 必須フィールドに値が入っていないため処理が中断された。 + yamori.error.v1.MissingFieldError missing_field = 4; + } + }
• packages/proto/yamori/workspace/v1/workspace_service.proto
  • @@ -9,12 +9,17 @@ import "yamori/workspace/v1/create_request.proto";
    import "yamori/workspace/v1/create_response.proto"; import "yamori/workspace/v1/delete_request.proto"; import "yamori/workspace/v1/delete_response.proto"; + import "yamori/workspace/v1/get_request.proto"; + import "yamori/workspace/v1/get_response.proto"; import "yamori/workspace/v1/list_request.proto"; import "yamori/workspace/v1/list_response.proto"; import "yamori/workspace/v1/update_request.proto"; import "yamori/workspace/v1/update_response.proto"; service WorkspaceService { + // ID を指定してワークスペースを取得する。 + rpc Get(GetRequest) returns (GetResponse); + // アクセス可能なワークスペースの一覧を返す。 rpc List(ListRequest) returns (ListResponse);