Skip to content

Commit

Permalink
fix: minor updates (#249)
Browse files Browse the repository at this point in the history
some minor updates, mostly with using the proto/
openapi shared example instead of hand-written ones.
  • Loading branch information
toumorokoshi authored Nov 19, 2024
1 parent fe52c14 commit 14c600b
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 10 deletions.
12 changes: 2 additions & 10 deletions aep/general/0133/aep.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,7 @@ Create methods are specified using the following pattern:

{% tab proto %}

```proto
rpc CreateBook(CreateBookRequest) returns (Book) {
option (google.api.http) = {
post: "/v1/{parent=publishers/*}/books"
body: "book"
};
option (google.api.method_signature) = "parent,book";
}
```
{% sample '../example.proto', 'rpc CreateBook' %}

- The RPC's name **must** begin with the word `Create`. The remainder of the
RPC name **should** be the singular form of the resource being created.
Expand All @@ -53,7 +45,7 @@ rpc CreateBook(CreateBookRequest) returns (Book) {
{% tab oas %}

```http
POST /v1/publishers/{publisher}/books?id=foo HTTP/2
POST /v1/publishers/{publisher}/books?id={book} HTTP/2
Host: bookstore.example.com
Accept: application/json
{
Expand Down
1 change: 1 addition & 0 deletions aep/general/0133/aep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ slug: create
created: 2023-03-08
placement:
category: standard-methods
order: 30
1 change: 1 addition & 0 deletions aep/general/0134/aep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ slug: update
created: 2023-01-22
placement:
category: standard-methods
order: 40
1 change: 1 addition & 0 deletions aep/general/0135/aep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ slug: delete
created: 2024-02-11
placement:
category: standard-methods
order: 60

0 comments on commit 14c600b

Please sign in to comment.