feat(140): make snake_case ubiquitous #297
Conversation
| hyphens (`-`) for underscores (`_`), emitted in lowercase, and parsed | ||
| case-insensitively. | ||
|
|
||
| **Note:** Regrettably, [ProtoJSON][proto-json] and [gRPC-Gateway][grpc-gateway] |
There was a problem hiding this comment.
Do we need "Regrettably"? Feels a bit editorial for the otherwise dry tone of the AEPs.
There was a problem hiding this comment.
I'm certainly not married to it, but I generally prefer to keep things a bit human? Happy to defer to consensus.
| JSON field names be in `lowerCamelCase` (whether or not they are backed by | ||
| equivalent protobufs). | ||
|
|
||
| **Important:** While APIs compliant with this AEP are required to use |
There was a problem hiding this comment.
This is a super nit, but these Note and Important blocks are related to each other -- but we aren't really representing that in the Markdown. I doubt we can nest an Important inside a Note, but maybe we just make this all one Important block? WDYT?
There was a problem hiding this comment.
Currently aside blocks don't seem to support more than one paragraph and it seemed unruly as a single paragraph so I did my best.
|
Demoting to a draft because I think this change might merit a blog post. |
Fixes #259.
Case transformation was going to continue to be a pain point, and
snake_casewas never clearly non-idiomatic for JSON. Better to consolidate behind a single case convention.🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
xin the boxesthat apply
📋 Your checklist for this pull request
Please review the AEP Style and Guidance for
contributing to this repository.
General
references AEPs
correctly.
(usually
prettier -w .)💝 Thank you!