Skip to content
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.

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

feat(AIP-203): introduce IDENTIFIER field behavior #1201

Merged
merged 7 commits into from
Aug 29, 2023

Conversation

toumorokoshi
Copy link
Contributor

@toumorokoshi toumorokoshi commented Aug 24, 2023

Identifier fields are often multi-modal: they are required or optional
in various situations. Adding an explicit field behavior for these
fields helps eliminate ambiguity for an author to fully annotate field
behavior on all request fields, as well as clarify which fields to use
in identifying the resource for clients.

fixes #1176.

Making it a bit easier to find the appropriate field behavior with
alphabetical sorting.
Identifier fields are often multi-modal: they are required or optional
in various situations. Adding an explicit field behavior for these
fields helps eliminate ambiguity for an author to fully annotate field
behavior on all request fields, as well as clarify which fields to use
in identifying the resource for clients.

fixes aip-dev#1176.
@toumorokoshi toumorokoshi requested a review from a team as a code owner August 24, 2023 23:16
@toumorokoshi toumorokoshi requested review from loudej, alin04, noahdietz and andrei-scripniciuc and removed request for loudej and alin04 August 24, 2023 23:16
@toumorokoshi toumorokoshi changed the title Toum/203-identifier feat(AIP-203): introduce IDENTIFIER field behavior Aug 24, 2023
Copy link
Collaborator

@noahdietz noahdietz left a comment

Choose a reason for hiding this comment

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

Can you include the Compatibility guidance in here as well (you documented it in the proposal doc).

Also, can you update other AIPs that portray the google.api.resource with a name field to include the IDENTIFIER value?

aip/general/0203.md Outdated Show resolved Hide resolved
aip/general/0203.md Outdated Show resolved Hide resolved
aip/general/0203.md Outdated Show resolved Hide resolved
aip/general/0203.md Outdated Show resolved Hide resolved
aip/general/0203.md Outdated Show resolved Hide resolved
@noahdietz
Copy link
Collaborator

Can you include the Compatibility guidance in here as well (you documented it in the proposal doc).

Also, can you update other AIPs that portray the google.api.resource with a name field to include the IDENTIFIER value?

Just friendly reminder that these would be nice too :) At least the first one.

@toumorokoshi toumorokoshi requested a review from a team as a code owner August 25, 2023 17:10
@toumorokoshi
Copy link
Contributor Author

Can you include the Compatibility guidance in here as well (you documented it in the proposal doc).
Also, can you update other AIPs that portray the google.api.resource with a name field to include the IDENTIFIER value?

Just friendly reminder that these would be nice too :) At least the first one.

good calls! done.

On the meta level: I think we have name in multiple places where it doesn't have to be. I started adding a comment to the effect of "here are the standard fields like google.api.resource and name" so we don't have to worry about updating every example. WDYT?

@noahdietz
Copy link
Collaborator

I think we have name in multiple places where it doesn't have to be. I started adding a comment to the effect of "here are the standard fields like google.api.resource and name" so we don't have to worry about updating every example. WDYT?

Oh man yeah there are a lot of spots...perhaps you are right this could be annoying to update in the future as well.

aip/general/0203.md Outdated Show resolved Hide resolved
- updating name examples with the field behavior
- adding backwards compatibility considerations
@toumorokoshi
Copy link
Contributor Author

done and done! please take another look.

@toumorokoshi toumorokoshi enabled auto-merge (squash) August 29, 2023 18:14
@toumorokoshi toumorokoshi merged commit cee645b into aip-dev:master Aug 29, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to define google.api.field_behavior for server-generated name field?
3 participants