proto: workspace_access_error を非推奨 not_found で事足りるため。エラーが分散するのが想像以上に使いづらい というのもある。

Changes

3 changed files (+16/-2)

• packages/proto/yamori/worker/v1/create_response.proto
  • @@ -7,6 +7,7 @@ package yamori.worker.v1;
    import "yamori/error/v1/capability_error.proto"; import "yamori/error/v1/missing_field_error.proto"; + import "yamori/error/v1/not_found.proto"; import "yamori/error/v1/system_error.proto"; import "yamori/worker/v1/worker.proto"; import "yamori/workspace/v1/access_error.proto";
  • @@ -21,7 +22,8 @@ oneof result {
    Result ok = 1; // 指定されたワークスペースにアクセスできないため作成されなかった。 - yamori.workspace.v1.AccessError workspace_access_error = 2; + // サーバは not_found を利用すること。 + yamori.workspace.v1.AccessError workspace_access_error = 2 [deprecated = true]; // システムエラーが発生した。 yamori.error.v1.SystemError system_error = 3;
  • @@ -31,5 +33,8 @@ yamori.error.v1.MissingFieldError missing_field = 4;
    // 権限がない、もしくはキーが不正。 yamori.error.v1.CapabilityError capability_error = 5; + + // 指定されたワークスペースが存在しない、アクセスできない。 + yamori.error.v1.NotFound not_found = 6; } }
• packages/proto/yamori/worker/v1/list_response.proto
  • @@ -6,6 +6,7 @@
    package yamori.worker.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/worker/v1/worker.proto"; import "yamori/workspace/v1/access_error.proto";
  • @@ -24,12 +25,16 @@ oneof result {
    Result ok = 1; // 指定されたワークスペースにアクセスできないため取得できなかった。 - yamori.workspace.v1.AccessError workspace_access_error = 2; + // サーバは not_found を返すこと。 + yamori.workspace.v1.AccessError workspace_access_error = 2 [deprecated = true]; // システムエラーが発生した。 yamori.error.v1.SystemError system_error = 3; // 必須フィールドに値が入っていない。 yamori.error.v1.MissingFieldError missing_field = 4; + + // 指定されたワークスペースが見つからない、アクセスできない。 + yamori.error.v1.NotFound not_found = 5; } }
• packages/proto/yamori/workspace/v1/access_error.proto
  • @@ -9,7 +9,11 @@ import "yamori/workspace/v1/workspace_id.proto";
    // ワークスペースにアクセスできない場合のエラー。 // 理由は様々だが、セキュリティのために詳細は含まれない。 + // + // yamori.error.v1.NotFound によって不要になった。 message AccessError { + option deprecated = true; + // アクセスできなかった対象のワークスペースの ID 。 WorkspaceID workspace_id = 1; }