Skip to content

Commit c6a8420

Browse files
authored
chore(AIP-136): add rationale for disallowing prepositions (#1471)
1 parent 9271057 commit c6a8420

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

aip/general/0136.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,14 @@ read data have first-class concepts in some clients (DataSources in
157157
Terraform) and clearly indicate to a user which methods can be called
158158
without risk of runtime impact.
159159

160+
### Disallowing prepositions
161+
162+
Generally, method names with prepositions indicate that a new method is being
163+
used where a field should instead be added to an existing method, or the method
164+
should use a distinct verb. For example, if a `CreateBook` message already
165+
exists and you are considering adding `CreateBookFromDictation`, consider a `TranscribeBook` method instead. Similarly, if there is desire for a
166+
property-specific look-up method, instead of `GetBookByAuthor` consider a
167+
`SearchBooks` with an `author` field as a search dimension.
160168

161169
[get]: ./0131.md
162170
[list]: ./0132.md
@@ -177,6 +185,7 @@ languages.
177185

178186
## Changelog
179187

188+
- **2025-01-09:** Add original rationale for disallowing prepositions in names.
180189
- **2023-11-16:** Included link to AIP-127 "HTTP and gRPC Transcoding" for guidance on body definition.
181190
- **2023-05-16:** Added prohibition of the term "async" within RPC names.
182191
- **2023-05-09:** Adding guidance for POST and GET, require parent instead of

0 commit comments

Comments
 (0)