Skip to content

Commit

Permalink
addressing feedback.
Browse files Browse the repository at this point in the history
  • Loading branch information
toumorokoshi committed Sep 14, 2024
1 parent b5b96ca commit 7ffc61d
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions aep/general/0162/aep.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,8 @@ useful include:
- Other resources depend on or descend from different revisions of a resource.
- There is a need to represent the change of a resource over time.

APIs implementing resources with revisions **should** model resource
revisions as a subresource of the resource. Sometimes, the revisions
collection can be a sibling collection of the resource it is a revision of.

For example, a resource revisions which may have a longer lifespan than the
parent resource, such as a database snapshot.
APIs implementing resources with revisions **must** model resource
revisions as a subresource of the resource.

{% tab proto %}

Expand All @@ -48,7 +44,7 @@ message BookRevision {
[(google.api.field_behavior) = OUTPUT_ONLY];

// Other revision IDs that share the same snapshot.
repeated string alternate_ids = 4
repeated string aliases = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
}
```
Expand Down Expand Up @@ -129,6 +125,8 @@ Services **may** reserve specific IDs to be [aliases][alias] (e.g.
GET /v1/publishers/{publisher_id}/books/{book_id}/revisions/{revision_id}
```

If specific IDs are reserved, services **should** document those IDs.

- If a `latest` ID exists, it **must** represent the most recently created
revision. The content of `publishers/{publisher}/books/{book}/revisions/latest`
and `publishers/{publisher}/books/{book}` can differ, as the latest revision may
Expand Down

0 comments on commit 7ffc61d

Please sign in to comment.