Skip to content

Conversation

cjschaef
Copy link
Member

@cjschaef cjschaef commented Nov 10, 2023

Add a new enum and values for IBM Cloud Service names.

Related: https://issues.redhat.com/browse/SPLAT-1097

Copy link
Contributor

openshift-ci bot commented Nov 10, 2023

Hello @cjschaef! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 10, 2023
@openshift-ci openshift-ci bot requested review from eparis and mfojtik November 10, 2023 21:26
@cjschaef
Copy link
Member Author

Should I also change the IBMCloudServiceEndpoint.Name to be this enum now, instead of simply a string, perhaps refactoring the type completely?

Name string `json:"name"`

We would prefer to keep the structure more flexible, if possible, like it manly is now.

@jeffnowicki
Copy link

jeffnowicki commented Nov 10, 2023

Should I also change the IBMCloudServiceEndpoint.Name to be this enum now, instead of simply a string, perhaps refactoring the type completely?

Name string `json:"name"`

We would prefer to keep the structure more flexible, if possible, like it manly is now.

I agree Chris (at least for now). Can revisit and refactor in future release if deemed necessary (or more desirable).

@JoelSpeed
Copy link
Contributor

Should I also change the IBMCloudServiceEndpoint.Name to be this enum now, instead of simply a string, perhaps refactoring the type completely?

Just change the type of the Name field from string to the new type. I'd then like you to add a godoc line that says, Possible values are CIS, COS,...

@cjschaef cjschaef force-pushed the ibmcloud_services_enum branch from 1069962 to 9fc0daf Compare November 10, 2023 22:41
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 10, 2023
@cjschaef
Copy link
Member Author

Updated.

Since we changes the IBMCloudServiceEndpont.Name type, I don't think the helper functions in library-go are necessary any longer. We can use the IBMCloudServiceName enum for comparisons as necessary downstream.

Add a new enum and values for IBM Cloud Service names.

Related: https://issues.redhat.com/browse/SPLAT-1097
@cjschaef cjschaef force-pushed the ibmcloud_services_enum branch from 9fc0daf to 2155ee0 Compare November 10, 2023 23:48
@cjschaef
Copy link
Member Author

cjschaef commented Nov 10, 2023

/retitle SPLAT-1097: IBMCloud: Add IBM Cloud Service names

@openshift-ci openshift-ci bot changed the title IBMCloud: Add IBM Cloud Service names SPLAT-1097: IBMCloud: Add IBM Cloud Service names Nov 10, 2023
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Nov 10, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 10, 2023

@cjschaef: This pull request references SPLAT-1097 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.15.0" version, but no target version was set.

In response to this:

Add a new enum and values for IBM Cloud Service names.

Related: https://issues.redhat.com/browse/SPLAT-1097

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.

@JoelSpeed
Copy link
Contributor

This API was added in #1499 which merged during the 4.15 release time frame, therefore the API hasn't hit a release yet. This doesn't change the serialisation of the field but does tighten the validation. Exception to the normal rule of not tightening the validation since this hasn't hit a release yet.

/lgtm

@JoelSpeed
Copy link
Contributor

/override ci/prow/e2e-aws-serial-techpreview

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 13, 2023
Copy link
Contributor

openshift-ci bot commented Nov 13, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cjschaef, JoelSpeed

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 Nov 13, 2023
Copy link
Contributor

openshift-ci bot commented Nov 13, 2023

@JoelSpeed: Overrode contexts on behalf of JoelSpeed: ci/prow/e2e-aws-serial-techpreview

In response to this:

/override ci/prow/e2e-aws-serial-techpreview

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.

Copy link
Contributor

openshift-ci bot commented Nov 13, 2023

@cjschaef: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@openshift-bot
Copy link

[ART PR BUILD NOTIFIER]

This PR has been included in build ose-cluster-config-api-container-v4.15.0-202311131732.p0.g39964e6.assembly.stream for distgit ose-cluster-config-api.
All builds following this will include this PR.

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. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants