Skip to content

Commit d2d7f06

Browse files
authored
Fix some incorrect identifiers in AEP-135: Delete: (#125)
* library.longrunning.Operation -> aep.api.Operation * name -> path
1 parent 031fbe8 commit d2d7f06

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

aep/general/0135/aep.md.j2

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Delete methods are specified using the following pattern:
3838
**should not** include optional fields in the query string unless described
3939
in another AEP.
4040
- Delete methods **should** return `204 No Content` with no response body, or
41-
`202 Accepted` with a representation of the operation in the response body
42-
if the delete is [long-running](#long-running-delete).
41+
`202 Accepted` with a representation of the operation in the response body if
42+
the delete is [long-running](#long-running-delete).
4343

4444
{% tab proto -%}
4545

@@ -48,9 +48,9 @@ Delete methods are specified using the following pattern:
4848
```proto
4949
rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {
5050
option (google.api.http) = {
51-
delete: "/v1/{name=publishers/*/books/*}"
51+
delete: "/v1/{path=publishers/*/books/*}"
5252
};
53-
option (google.api.method_signature) = "name";
53+
option (google.api.method_signature) = "path";
5454
}
5555
```
5656

@@ -59,16 +59,16 @@ rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {
5959
- The request message **must** match the RPC name, with a `Request` suffix.
6060
- The response message **should** be `google.protobuf.Empty`.
6161
- If the delete RPC is [long-running](#long-running-delete), the response
62-
message **must** be a `library.longrunning.Operation` which resolves to the
63-
correct response.
64-
- The request message field receiving the resource name **should** map to the
62+
message **must** be a `aep.api.Operation` which resolves to the correct
63+
response.
64+
- The request message field receiving the resource path **should** map to the
6565
URI path.
66-
- This field **should** be called `name`.
67-
- The `name` field **should** be the only variable in the URI path. All
66+
- This field **should** be called `path`.
67+
- The `path` field **should** be the only variable in the URI path. All
6868
remaining parameters **should** map to URI query parameters.
6969
- There **must not** be a `body` key in the `google.api.http` annotation.
7070
- There **should** be exactly one `google.api.method_signature` annotation,
71-
with a value of `"name"`. If an etag or force field are used, they **may** be
71+
with a value of `"path"`. If an etag or force field are used, they **may** be
7272
included in the signature.
7373

7474
Delete methods implement a common request pattern:
@@ -121,11 +121,11 @@ instead: [AEP-151][aep-151].
121121
{% tab proto -%}
122122

123123
```proto
124-
rpc DeleteBook(DeleteBookRequest) returns (library.longrunning.Operation) {
124+
rpc DeleteBook(DeleteBookRequest) returns (aep.api.Operation) {
125125
option (google.api.http) = {
126-
delete: "/v1/{name=publishers/*/books/*}"
126+
delete: "/v1/{path=publishers/*/books/*}"
127127
};
128-
option (library.longrunning.operation_info) = {
128+
option (aep.api.operation_info) = {
129129
response_type: "google.protobuf.Empty"
130130
metadata_type: "OperationMetadata"
131131
};
@@ -162,9 +162,9 @@ The API **must** fail with a `409 Conflict` error if the `force` field is
162162

163163
```proto
164164
message DeletePublisherRequest {
165-
// The name of the publisher to delete.
165+
// The path of the publisher to delete.
166166
// Format: publishers/{publisher}
167-
string name = 1 [
167+
string path = 1 [
168168
(google.api.field_behavior) = REQUIRED,
169169
(google.api.resource_reference) = {
170170
type: "library.example.com/Publisher"

0 commit comments

Comments
 (0)