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

Create standard recommendations / best practices doc for name fields #20773

Open
melinath opened this issue Dec 20, 2024 · 0 comments
Open

Create standard recommendations / best practices doc for name fields #20773

melinath opened this issue Dec 20, 2024 · 0 comments

Comments

@melinath
Copy link
Collaborator

What kind of contribution is this issue about?

MMv1-based resource

Details

Currently, there are a lot of different ways to implement name fields. The two main approaches are:

  • As an output-only field, with a separate immutable URL param field that gets sent on create
  • As a read/write field that uses a combination of expanders/flatteners/diff suppression/ignore_read to prevent diffs

Some resources also (incorrectly in some cases? but maybe correctly in others?) mark the field as default_from_api.

We should document what the best practices are.

Based on the results, we may also want to open follow-up tickets to:

  • Standardize the behavior / configuration of existing resources, to make it more clear to contributors what the best practices are and to make things more likely to behave as users expect
  • Create a Name field type that behaves in a more standard way

References

yaqs/3175428063924060160
Potentially related: #20109

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