Protocol Buffersのenum型名を確認

enum型名には大文字で始まるTitleCaseを使ってください。

説明

Protocol Buffersのスタイルガイドは、enum型名にJobStatusのようなTitleCaseを推奨しています。コードの一貫性のための規則であり、名前の形式だけでセキュリティ上の脆弱性になるわけではありません。

想定される影響

命名が一貫していないと、生成コードやドキュメントの読解、保守が難しくなる場合があります。

対処方法

enum型名をTitleCaseで記述してください。既存の型名を変える前に、生成APIを利用するコードの参照も確認し、一緒に修正してください。

例

型名だけをJobStatusに変更し、enumの値と数値は維持します。2つのコードは独立した例です。

変更前

proto
syntax = "proto3";

enum NOT_CAMEL_CASE {
  UNKNOWN = 0;
  STARTED = 1;
  RUNNING = 2;
}

変更後

proto
syntax = "proto3";

enum JobStatus {
  UNKNOWN = 0;
  STARTED = 1;
  RUNNING = 2;
}

参考資料