Skip to content

Clarify method naming #1498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kaibolay wants to merge 2 commits into from
Closed

Clarify method naming #1498

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a9f93a
Clarify method naming
kaibolay Mar 20, 2025
eb892ae
expand cases when a noun should used
kaibolay Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion aip/general/0136.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ rpc ArchiveBook(ArchiveBookRequest) returns (ArchiveBookResponse) {
resource. Custom methods can be associated with resources, collections, or
services. The bullets below apply in all three cases.

- The name of the method **should** be a verb followed by a noun.
- The name of the method **should** be a verb (for resource-based and collection-based
custom methods where the method refers to the resource or collection itself) or a verb
followed by a noun (for resource-based and collection-based which don't refer to the
resource or collection itself or for stateless methods).
- The name **must not** contain prepositions ("for", "with", etc.).
- The verb in the name **should not** contain any of the standard method verbs ([Get][],
[List][], [Create][], [Update][], [Delete][]).
Expand Down Expand Up @@ -185,6 +188,7 @@ languages.

## Changelog

- **2025-03-20:** Clarify method naming: names for resource-base and collection-based methods can be a verb only.
- **2025-01-09:** Add original rationale for disallowing prepositions in names.
- **2023-11-16:** Included link to AIP-127 "HTTP and gRPC Transcoding" for guidance on body definition.
- **2023-05-16:** Added prohibition of the term "async" within RPC names.
Expand Down