Skip to content

Commit 09d1f99

Browse files
committed
fix(140): addition more explanation for cases
Clarifying the importance of the usage of uniform lower_snake_case across json and grpc
1 parent 01c82ef commit 09d1f99

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

aep/general/0140/aep.md.j2

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ generated code.
4444
transformed by substituting hyphens (`-`) for underscores (`_`), emitted in
4545
lowercase, and parsed case-insensitively.
4646

47+
Although gRPC-json transcoding often translates snake_case names to camelCase,
48+
this variance can force additional complexity server-side to translate the
49+
values in contexts such as in filter syntax.
50+
4751
#### Support for lowerCamelCase in clients
4852

4953
[ProtoJSON][proto-json] and [gRPC-Gateway][grpc-gateway] by default both

aep/general/0155/aep.md.j2

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,10 @@ message CreateBookRequest {
4848

4949
- [`aep.api.IdempotencyKey`][IdempotencyKey] has a `key` and a `first_sent`
5050
timestamp.
51-
5251
- `key` is simply a unique identifier.
5352

5453
- Providing an idempotency key **must** guarantee idempotency.
55-
5654
- If a duplicate request is detected, the server **must** return one of:
57-
5855
- A response equivalent to the response for the previously successful
5956
request, because the client most likely did not receive the previous
6057
response.
@@ -75,7 +72,6 @@ message CreateBookRequest {
7572

7673
- The `idempotency_key` field **must** be provided on the request message to
7774
which it applies (and it **must not** be a field on resources themselves).
78-
7975
- The `first_sent` field can be used by API servers to determine if a key is
8076
expired. API servers **must** reject requests with expired keys, and
8177
**must** reject requests with keys that are in the future. When feasible,

0 commit comments

Comments
 (0)