Skip to content

Commit 62e888e

Browse files
authored
Merge pull request #23 from G8XSU/nitdocs
Fix doc nits
2 parents d899167 + 49dab97 commit 62e888e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

app/src/main/proto/vss.proto

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ message GetObjectRequest {
1414
// Authorization and billing can also be performed at the `store_id` level.
1515
string store_id = 1;
1616

17-
// `Key` for which the value is to be fetched.
17+
// The key of the value to be fetched.
1818
//
19-
// If the specified `key` does not exist, returns `ErrorResponse` with `NO_SUCH_KEY_EXCEPTION` as
20-
// `ErrorCode`.
19+
// If the specified `key` does not exist, returns `ErrorCode.NO_SUCH_KEY_EXCEPTION` in the
20+
// the `ErrorResponse`.
2121
//
2222
// Consistency Guarantee:
2323
// Get(read) operations against a `key` are consistent reads and will reflect all previous writes,
@@ -266,21 +266,21 @@ enum ErrorCode {
266266
// Default protobuf Enum value. Will not be used as `ErrorCode` by server.
267267
UNKNOWN = 0;
268268

269-
// CONFLICT_EXCEPTION is used when the request contains mismatched version (either key or global)
269+
// Used when the request contains mismatched version (either key or global)
270270
// in `PutObjectRequest`. For more info refer `PutObjectRequest`.
271271
CONFLICT_EXCEPTION= 1;
272272

273-
// INVALID_REQUEST_EXCEPTION is used in the following cases:
273+
// Used in the following cases:
274274
// - The request was missing a required argument.
275275
// - The specified argument was invalid, incomplete or in the wrong format.
276276
// - The request body of api cannot be deserialized into corresponding protobuf object.
277277
INVALID_REQUEST_EXCEPTION = 2;
278278

279-
// An internal server error occurred, client is probably at no fault and can safely retry this
280-
// error with exponential backoff.
279+
// Used when an internal server error occurred, client is probably at no fault and can safely retry
280+
// this error with exponential backoff.
281281
INTERNAL_SERVER_EXCEPTION = 3;
282282

283-
// NO_SUCH_KEY_EXCEPTION is used when the specified `key` in a `GetObjectRequest` does not exist.
283+
// Used when the specified `key` in a `GetObjectRequest` does not exist.
284284
NO_SUCH_KEY_EXCEPTION = 4;
285285
}
286286

0 commit comments

Comments
 (0)