Skip to content

Update fields in the spec to no longer be a pointer #1146

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

Closed
Tracked by #740
everettraven opened this issue Aug 19, 2024 · 0 comments · Fixed by #1223
Closed
Tracked by #740

Update fields in the spec to no longer be a pointer #1146

everettraven opened this issue Aug 19, 2024 · 0 comments · Fixed by #1223
Assignees
Labels
epic/v1-api good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. v1.0 Issues related to the initial stable release of OLMv1
Milestone

Comments

@everettraven
Copy link
Contributor

everettraven commented Aug 19, 2024

As outlined in the Pointers subsection of the OpenShift API Conventions, in configuration APIs, pointers should only be used when there is an explicit need to distinguish between a zero value and a nil value. An exception here is pointers in the Status subresource since a nil value has a different meaning in the Status subresource than the Spec.

We propose that the following fields, not having the explicit need to distinguish between the zero and nil values, should be updated to no longer be pointers:

The following fields do not have the explicit need to distinguish between the zero and nil values, meaning they should be updated to no longer be pointers based on the OpenShift API Conventions:

@everettraven everettraven added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. v1.0 Issues related to the initial stable release of OLMv1 epic/v1-api labels Aug 20, 2024
@everettraven everettraven added this to the v1.0.0 milestone Aug 20, 2024
@rashmigottipati rashmigottipati self-assigned this Aug 21, 2024
@everettraven everettraven moved this from Implementing to Ready for Review in OLM v1 Aug 26, 2024
@grokspawn grokspawn self-assigned this Sep 4, 2024
@grokspawn grokspawn moved this from Implementing to Ready for Review in OLM v1 Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic/v1-api good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. v1.0 Issues related to the initial stable release of OLMv1
Projects
Archived in project
3 participants