Comment update

This commit is contained in:
Uwe Seimet 2021-12-17 19:45:20 +01:00
parent 7d543451f0
commit 6c4103989b

View File

@ -162,7 +162,8 @@ enum PbOperation {
// The operation parameter meta data
message PbOperationParameter {
string name = 1;
// Optional short localized description, key is the lower case locale (e.g. en, de)
// Optional short localized description, key is the lower case locale (e.g. en, de).
// Falling back to "en" is recommended if a description for a different language is missing.
map<string, string> description = 2;
// "string", "int", or "boolean". Parameters are always strings but must be convertible to these types.
string type = 3;
@ -174,7 +175,8 @@ message PbOperationParameter {
// The list of parameters supported by an operation
message PbOperationParameters {
string name = 1;
// Optional short localized description, key is the lower case locale (e.g. en, de)
// Optional short localized description, key is the lower case locale (e.g. en, de).
// Falling back to "en" is recommended if a description for a different language is missing.
map<string, string> description = 2;
repeated PbOperationParameter parameters = 3;
}