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

WIP: internal: add api helper #1053

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shajmakh
Copy link
Member

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.

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]>
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 21, 2024
Copy link
Contributor

openshift-ci bot commented Oct 21, 2024

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 21, 2024
@shajmakh
Copy link
Member Author

depends on: #1052

Copy link
Member

@ffromani ffromani left a 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
Copy link
Member

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.

Copy link
Member

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 {
Copy link
Member

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(),
}
}
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants