aip-dev / google.aip.dev

API Improvement Proposals. https://aip.dev/
Other
1.08k stars 495 forks source link

feat(AIP-217): reformat guidance and explicitly state name format #1393

Closed noahdietz closed 2 months ago

noahdietz commented 2 months ago

Specific guidance for contents of unreachable: The unreachable field **must** contain service-relative resource names, and **must not** contain full resource names or simple resource IDs or resource URIs.

Clarify language regarding unreachable follow up: The service **must** provide a way for the user to get an error with additional information e.g. a Standard Get RPC or a Standard List targeted at the unreachable collection parent.

Restructure existing guidance to make each point accessible, examples clear, and exceptions isolated.

Internal bug for doc(s) and details: http://b/350788888

Note: For observers sake, the reviewers of this PR are not the only reviewers of this change, they are simply the GitHub reviewers for the changes already approved by a broader set of reviewers.