Skip to content

fix(AIP-140): add uri guidance rationale #1490

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

Merged
noahdietz merged 3 commits into from
Mar 14, 2025
Merged

fix(AIP-140): add uri guidance rationale #1490

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1318783
fix(AIP-140): add uri guidance rationale
noahdietz Mar 10, 2025
68acec4
Merge branch 'master' into aip-140-uri-rationale
noahdietz Mar 13, 2025
d4d8e4a
Merge branch 'master' into aip-140-uri-rationale
noahdietz Mar 14, 2025
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
11 changes: 11 additions & 0 deletions aip/general/0140.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,19 @@ field **should not** have a uniqueness requirement.
- For naming fields representing quantities, see [AIP-141][].
- For naming fields representing time, see [AIP-142][].

## Rationale

### URI vs URL

The guidance itself mentions that all URLs are URIs, but not all URIs are URLs.
The goal of aligning on URI is to enable a more generalizable field, that can
handle a variety of use cases, as well as drive standardization across APIs,
creating a more coherent surface. At the same time, the requirement being a
**should** allows for more specific terms when it truly merits it.

## Changelog

- **2025-03-10**: Add rationale for URI guidance.
- **2024-12-20**: Copy over abbreviations guidance from old design site.
- **2024-08-26**: Codify exception to string and base64 guidance
- **2024-05-18**: Documented the effect of field names on client surfaces.
Expand Down