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

Consider naming TypedLocalObjectReference fields fooRef #50

Closed
jpeach opened this issue Jan 24, 2020 · 10 comments
Closed

Consider naming TypedLocalObjectReference fields fooRef #50

jpeach opened this issue Jan 24, 2020 · 10 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@jpeach
Copy link
Contributor

jpeach commented Jan 24, 2020

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#naming-conventions

The name of a field referring to another resource of kind Foo by name should be called fooName. The name of a field referring to another resource of kind Foo by ObjectReference (or subset thereof) should be called fooRef.

Following this recommendation would replace Extension with ExtensionRef, but it would also replace ForwardTo with something less wieldy (maybe TargetRef). So maybe it's better not to follow this convention in all cases.

@bowei
Copy link
Contributor

bowei commented Jan 24, 2020

This reminds me of "Hungarian notation". I think we should try to make it align, but use common sense.

@Miciah
Copy link
Contributor

Miciah commented Jan 28, 2020

While we consider the naming, we should also consider using custom types instead of ObjectReference and TypedLocalObjectReference, per the recommendation in kubernetes/kubernetes#87459. (Let me know if you would prefer a separate issue for the type issue.)

@bowei bowei added the kind/feature Categorizes issue or PR as related to a new feature. label Jan 30, 2020
@bowei
Copy link
Contributor

bowei commented Feb 6, 2020

Let's open a PR against the developer guide section of the docs and continue the discussion there.

@jpeach
Copy link
Contributor Author

jpeach commented Feb 7, 2020

/assign

@jpeach
Copy link
Contributor Author

jpeach commented Feb 7, 2020

/unassign

@Miciah
Copy link
Contributor

Miciah commented Feb 11, 2020

Opened #73 to replace types.

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 11, 2020
@robscott
Copy link
Member

I believe this was fixed by #73, feel free to reopen if I missed anything.

@robscott
Copy link
Member

/close

@k8s-ci-robot
Copy link
Contributor

@robscott: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

jaison-tiu pushed a commit to jaison-tiu/gateway-api that referenced this issue Apr 14, 2022
…pc-api

Update to networkingv1; omit TLS HC
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

6 participants