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

AIP-122: The _name suffix restriction should only be applied to fields representing a resource #1179

Open
SanjayVas opened this issue Jun 20, 2023 · 0 comments

Comments

@SanjayVas
Copy link

SanjayVas commented Jun 20, 2023

The following line in the AIP

Field names should not use the _name suffix unless the field would be
ambiguous without it (e.g., crypto_key_name)

Is under the section "Fields representing another resource". The statement does not apply generally to all fields, only fields that represent a resource. Indeed, there's a note in the same AIP that explicitly suggests using the _name suffix for fields that are not resource references:

Note: Fields must not be called name except for this purpose. For
other use cases, either use a different term or prepend an adjective (for
example: display_name).

The current implementation for the core::0122::name-suffix rule, and indeed even its documentation incorrectly complains if it sees the _name suffix on any field.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant