-
Notifications
You must be signed in to change notification settings - Fork 13
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
WIP: internal: add api helper #1053
base: main
Are you sure you want to change the base?
Conversation
We want to keep the main api package with the least possible dependencies but we still want to have additional helper functions for some types. Create this helper under `internal/` where the dependecies are already pulled and update relevant instances. Signed-off-by: Shereen Haj <[email protected]>
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: shajmakh The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
depends on: #1052 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
this make me realize I need to add docs to our package to express the intent of these
@@ -0,0 +1,22 @@ | |||
package api |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can and should move this in
api/numaresourcesoperator/v1/helper/
we can call it namespacedname
(package namespacedname
)
packages in .../helper
build on top of the main api package, so we can add deps (in a reasonnable fashion) here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add the copyright boilerplate (hack/boilerplate.go.txt
)
} | ||
} | ||
|
||
func NamespacedNameFromObject(obj metav1.Object) nropv1.NamespacedName { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if we move as suggested, this can be just FromObject
(and should probably take a client.Object
)
Namespace: obj.GetNamespace(), | ||
Name: obj.GetName(), | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add a simple test which does roundtrip(s). Should be sufficient to prove the correctness.
We want to keep the main api package with the least possible dependencies but we still want to have additional helper functions for some types. Create this helper under
internal/
where the dependecies are already pulled and update relevant instances.