Skip to content

Commit c7b6e98

Browse files
authored
fix(231): change batchGet to batch-get for casing consistency across AEP (#407)
This PR updates AEP-0231 (Batch GET) to use batch-get instead of batchGet / BatchGet in HTTP URI custom method names. This ensures consistent kebab-case naming for custom methods across the AEP, aligning with the casing conventions used by other AEPs (e.g., AEP 122).
1 parent df45f50 commit c7b6e98

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

aep/general/0231/aep.md.j2

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ APIs **may** support batch get to retrieve a consistent set of resources.
1111
- The method's name **must** begin with `BatchGet`. The remainder of the method
1212
name **must** be the plural form of the resource being retrieved.
1313
- The HTTP verb **must** be `GET`.
14-
- The HTTP URI **must** end with `:batchGet`.
14+
- The HTTP URI **must** end with `:batch-get`.
1515
- The URI path **must** represent the collection for the resource, matching the
1616
collection used for simple CRUD operations. If the operation spans parents, a
1717
[wilcard](./reading-across-collections) **may** be accepted.
@@ -45,7 +45,7 @@ pattern:
4545
```proto
4646
rpc BatchGetBooks(BatchGetBooksRequest) returns (BatchGetBooksResponse) {
4747
option (google.api.http) = {
48-
get: "/v1/{parent=publishers/*}/books:batchGet"
48+
get: "/v1/{parent=publishers/*}/books:batch-get"
4949
};
5050
}
5151

@@ -121,7 +121,7 @@ message BatchGetBooksResponse {
121121

122122
{% tab oas %}
123123

124-
{% sample 'batchget.oas.yaml', '$.paths./publishers/{publisherId}/books:BatchGet' %}
124+
{% sample 'batchget.oas.yaml', '$.paths./publishers/{publisherId}/books:batch-get' %}
125125

126126
Example response body:
127127

aep/general/0231/batchget.oas.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
title: Library
44
version: 1.0.0
55
paths:
6-
/publishers/{publisherId}/books:BatchGet:
6+
/publishers/{publisherId}/books:batch-get:
77
parameters:
88
- name: publisherId
99
in: path

0 commit comments

Comments
 (0)