feat: AIP-140 – Field names #33
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukesneeringer
commented
May 18, 2021
|
|
||
| ### Consistency | ||
|
|
||
| APIs **should** endeavor to use the same name for the same concept and |
There was a problem hiding this comment.
@mkistler: One thing we do is check type / name consistency.
lukesneeringer
commented
May 18, 2021
aip/general/0140/aip.md
Outdated
|
|
||
| ### Array fields | ||
|
|
||
| Repeated fields **must** use the proper plural form, such as `books` or |
lukesneeringer
commented
May 18, 2021
aip/general/0140/aip.md
Outdated
|
|
||
| Repeated fields **must** use the proper plural form, such as `books` or | ||
| `authors`. On the other hand, non-array fields **should** use the singular form | ||
| such as `book` or `author`.. |
There was a problem hiding this comment.
Suggested change
| such as `book` or `author`.. | |
| such as `book` or `author`. |
lukesneeringer
commented
May 18, 2021
lukesneeringer
commented
May 18, 2021
lukesneeringer
commented
May 18, 2021
lukesneeringer
commented
May 18, 2021
lukesneeringer
commented
May 18, 2021
aip/general/0140/aip.md
Outdated
|
|
||
| ### String vs. bytes | ||
|
|
||
| When using `bytes`, the contents of the field are base64-encoded when using |
There was a problem hiding this comment.
are -> must or should
lukesneeringer
commented
May 25, 2021
|
|
||
| ### String vs. bytes | ||
|
|
||
| When there is a need to send binary contents over the wire, the contents |
There was a problem hiding this comment.
Nit: Capitalize Base64 throughout.
mkistler
approved these changes
Oct 30, 2022
| ### URIs | ||
|
|
||
| Field names representing URLs or URIs **should** use `url` for fully-qualified | ||
| URLs, and URIs for URI segment. Field names **may** use a prefix in front of |
There was a problem hiding this comment.
Did you mean
Suggested change
| URLs, and URIs for URI segment. Field names **may** use a prefix in front of | |
| URLs, and `uri` for URI segment. Field names **may** use a prefix in front of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.