Skip to content

Commit fbb5336

Browse files
authored
AIP-136: formally discourage use of standard verbs in names (#1028)
1 parent a0576cf commit fbb5336

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

aip/general/0136.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: 136
33
state: approved
44
created: 2019-01-25
5-
updated: 2022-06-02
5+
updated: 2023-03-02
66
placement:
77
category: operations
88
order: 100
@@ -42,6 +42,8 @@ services. The bullets below apply in all three cases.
4242

4343
- The name of the method **should** be a verb followed by a noun.
4444
- The name **must not** contain prepositions ("for", "with", etc.).
45+
- The verb in the name **should not** contain any of the standard method verbs ([Get][],
46+
[List][], [Create][], [Update][], [Delete][]).
4547
- The HTTP method for custom methods **should** usually be `POST`, unless the
4648
custom method maps more strongly to another HTTP verb.
4749
- Custom methods that serve as an alternative to get or list methods (such as
@@ -117,8 +119,15 @@ An exception to this is for rarely-used, fundamentally imperative operations,
117119
such as a `Move` or `Rename` operation, for which there would not be an
118120
expectation of declarative support.
119121

122+
[get]: ./0131.md
123+
[list]: ./0132.md
124+
[create]: ./0133.md
125+
[update]: ./0134.md
126+
[delete]: ./0135.md
127+
120128
## Changelog
121129

130+
- **2023-03-02:** Explicitly discourage use of standard method verbs.
122131
- **2022-06-02:** Changed suffix descriptions to eliminate superfluous "-".
123132
- **2020-10-06:** Added declarative-friendly guidance.
124133
- **2019-08-01:** Changed the examples from "shelves" to "publishers", to

0 commit comments

Comments
 (0)