Skip to content

Add missing links for management plane and strong consistency #1215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schedutron wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing links for management plane and strong consistency #1215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions aip/general/0133.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ rpc CreateBook(CreateBookRequest) returns (Book) {
- There **should** be exactly one `google.api.method_signature` annotation,
with a value of `"parent,{resource},{resource}_id"`, or "`"parent,{resource}"`
if the resource ID is not required.
- If the API is operating on the [management plane][], the operation should have
[strong consistency][]: the completion of a create operation **must** mean
- If the API is operating on the [management plane](https://google.aip.dev/111#management-plane), the operation should have
Copy link
Collaborator

@noahdietz noahdietz Sep 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- If the API is operating on the [management plane](https://google.aip.dev/111#management-plane), the operation should have
- If the API is operating on the [management plane][], the operation should have

Revert this, please. The change you've made isn't necessary, this already properly linked:
Screenshot 2023-09-12 at 9 13 52 AM

[strong consistency](https://google.aip.dev/121#strong-consistency): the completion of a create operation **must** mean
Copy link
Collaborator

@noahdietz noahdietz Sep 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We prefer to use text references instead of inline links. The reason this isn't linking properly is because the text reference at the bottom is not aligned with the text here. The text here is strong consistency but the text reference on line 216 (incorrectly) expects strongly consistent. That should be corrected to strong consistency instead so that this text reference link works unchanged.

Suggested change
[strong consistency](https://google.aip.dev/121#strong-consistency): the completion of a create operation **must** mean
[strong consistency][]: the completion of a create operation **must** mean

that all user-settable values and the existence of the resource have reached a
steady-state and reading resource state returns a consistent response.

Expand Down