fix(Partner Center Sell): re-gen service after recent API definition changes #358

HarasztiaPeter · 2024-10-02T11:29:01Z

PR summary

PR Checklist

Please make sure that your PR fulfills the following requirements:

The commit message follows the Angular Commit Message Guidelines.
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Current vs new behavior

Does this PR introduce a breaking change?

Yes
No

Other information

HarasztiaPeter · 2024-10-02T11:33:58Z

The docs were updated as well under the https://test.cloud.ibm.com/apidocs/partner-center-sell?code=go link

HarasztiaPeter · 2024-10-02T12:26:03Z

Test run

HarasztiaPeter · 2024-10-02T13:12:35Z

Link to yaml https://product-lifecycle.api.test.cloud.ibm.com/openapi/v1/openapi.yaml

padamstx · 2024-10-02T14:26:31Z

partnercentersellv1/partner_center_sell_v1.go

@@ -3155,13 +3045,13 @@ type CatalogHighlightItem struct {
 	Description *string `json:"description,omitempty"`

 	// The description about the features of the product in translation.
-	DescriptionI18n map[string]string `json:"description_i18n,omitempty"`
+	DescriptionI18n map[string]interface{} `json:"description_i18n,omitempty"`


The map[string]interface{} type results from the definition of the CatalogProductHighlightDescriptionI18n schema:

CatalogProductHighlightDescriptionI18n: type: object description: The description about the features of the product in translation. additionalProperties: true

Are you sure that using interface{} for the map value type is correct? Using interface{} types just makes it harder for users to deal with the values as a type assertion would be needed. If you know that the values will be strings, then you could change additionalProperties to be:

CatalogProductHighlightDescriptionI18n: type: object description: The description about the features of the product in translation. additionalProperties: type: string

We had issue with passing custom data, in terraform this change seems to solve that problem.

What do you mean specifically by "custom data"? Does the service support values of any type (string, boolean, integer, object, float, etc.)?

Readded types

partnercentersellv1/partner_center_sell_v1_examples_test.go

padamstx · 2024-10-02T15:38:57Z

partnercentersellv1/partner_center_sell_v1_integration_test.go

@@ -349,43 +279,52 @@ var _ = Describe(`PartnerCenterSellV1 Integration Tests`, func() {

 			catalogHighlightItemModel := &partnercentersellv1.CatalogHighlightItem{
 				Description:     core.StringPtr("highlight desc"),
-				DescriptionI18n: map[string]string{"key1": "desc"},
+				DescriptionI18n: map[string]interface{}{"key1": "testString"},


Wherever you see a mock value like "testString" being used in the generated integration tests or examples code, that is an opportunity to define a realistic example value in the API definition. The added benefit is that these example values will be used in the generated examples and that means that the programming examples will look "similar" (other than language-specific differences) across the languages and will help promote easier understanding of the API.

Here's a tutorial video that discusses this:
https://secure.video.ibm.com/channel/23887899/playlist/651457/video/133486087

Its true, but right now we do not plan to go into other languages. The main use case for this service is still terraform. Somewhere in the docs we should add the following warning:
Note - Intended for internal use only. This resource is strictly experimental and subject to change without notice.
(it has been added to related terraform docs as well.)

You could perhaps update the service table in README.md to include Experimental after the service name:

You could perhaps also add Note: the Partner Center Sell service is intended for internal use only. This service is strictly experimental and subject to change without notice. just after the table of "moved" services:

(right before Prerequisites)

Its true, but right now we do not plan to go into other languages.

Even if you are only going to produce a Go SDK and Terraform provider, the ability to generate the integration tests and examples code when a change is made to the API (without needing to make manual changes) will save you lots of time in the future.

If you don't mind the example fix would go to the next PR.

partnercentersellv1/partner_center_sell_v1_integration_test.go

padamstx

Removed my approval until some of the comments have been reviewed and a decision is made as to whether or not to address them.

…d to the service Signed-off-by: Peter Harasztia <[email protected]>

Signed-off-by: Peter Harasztia <[email protected]>

Co-authored-by: Phil Adams <[email protected]> Signed-off-by: Peter Harasztia <[email protected]>

Signed-off-by: Peter Harasztia <[email protected]>

partnercentersellv1/partner_center_sell_v1_examples_test.go

padamstx

A couple of minor changes needed. Re: the other questions, I don't think they're showstoppers, so just let me know if you want to ignore for now and I can merge.

Signed-off-by: Peter Harasztia <[email protected]>

…on comments Signed-off-by: Peter Harasztia <[email protected]>

Signed-off-by: Peter Harasztia <[email protected]>

padamstx

Getting closer. Just need to resolve the default service URL and I was just curious about the change to the CM int test.

partnercentersellv1/partner_center_sell_v1.go

catalogmanagementv1/catalog_management_v1_integration_test.go

Signed-off-by: Peter Harasztia <[email protected]>

HarasztiaPeter · 2024-10-07T12:13:05Z

The cm test was a mistake removed it.

padamstx

LGTM

## [0.69.2](v0.69.1...v0.69.2) (2024-10-07) ### Bug Fixes * **Partner Center Sell:** re-gen service after recent API definition changes ([#358](#358)) ([36d86ae](36d86ae))

ibm-devx-sdk · 2024-10-07T15:27:47Z

🎉 This PR is included in version 0.69.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [0.69.2](IBM/platform-services-go-sdk@v0.69.1...v0.69.2) (2024-10-07) ### Bug Fixes * **Partner Center Sell:** re-gen service after recent API definition changes ([IBM#358](IBM#358)) ([36d86ae](IBM@36d86ae)) Signed-off-by: manu.k.m <[email protected]>

HarasztiaPeter requested a review from padamstx October 2, 2024 13:10

padamstx self-assigned this Oct 2, 2024

padamstx approved these changes Oct 2, 2024

View reviewed changes

padamstx self-requested a review October 2, 2024 18:53

padamstx reviewed Oct 2, 2024

View reviewed changes

padamstx changed the title ~~Update partnercentersellv1~~ fix(Partner Center Sell): re-gen service after recent API definition changes Oct 2, 2024

padamstx self-requested a review October 2, 2024 18:58

HarasztiaPeter and others added 14 commits October 3, 2024 10:53

update(partner center sell): test rework in progress and changes adde…

31bb9ae

…d to the service Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): integration tests written and working

b30036c

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): minor fix

e07388b

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): minor fix

097fa32

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): restore deleted test

8aae26c

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): false secret fix

f43213c

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): resource broker fields fixed

687a1b3

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): test resturcture

c4e702d

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): composite service supported

cfaac17

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): composite service test data fix

5ee2e20

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): default url changed

57319dc

Signed-off-by: Peter Harasztia <[email protected]>

Update partnercentersellv1/partner_center_sell_v1_examples_test.go

7dd93f6

Co-authored-by: Phil Adams <[email protected]> Signed-off-by: Peter Harasztia <[email protected]>

Update partnercentersellv1/partner_center_sell_v1_examples_test.go

a20531e

Co-authored-by: Phil Adams <[email protected]> Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): grouped comments for env variables

9a9e326

Signed-off-by: Peter Harasztia <[email protected]>

HarasztiaPeter force-pushed the update-partnercentersellv1 branch from a017a8b to 9a9e326 Compare October 3, 2024 08:53

padamstx reviewed Oct 3, 2024

View reviewed changes

partnercentersellv1/partner_center_sell_v1_examples_test.go Show resolved Hide resolved

padamstx reviewed Oct 3, 2024

View reviewed changes

partnercentersellv1/partner_center_sell_v1_examples_test.go Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

padamstx self-requested a review October 3, 2024 18:35

padamstx requested changes Oct 3, 2024

View reviewed changes

HarasztiaPeter added 4 commits October 4, 2024 10:15

update(partner center sell): env variable naming fix

4646b2c

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): reworked additional property type based …

b64168b

…on comments Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): test data fix

83e6b1b

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): detect secret fix

378b83b

Signed-off-by: Peter Harasztia <[email protected]>

HarasztiaPeter requested a review from padamstx October 4, 2024 13:59

padamstx reviewed Oct 4, 2024

View reviewed changes

partnercentersellv1/partner_center_sell_v1.go Outdated Show resolved Hide resolved

catalogmanagementv1/catalog_management_v1_integration_test.go Outdated Show resolved Hide resolved

HarasztiaPeter added 2 commits October 7, 2024 09:01

update(partner center sell): revert not needed changes

54b09d0

Signed-off-by: Peter Harasztia <[email protected]>

update(partner center sell): default url set to prod

464cf2b

Signed-off-by: Peter Harasztia <[email protected]>

HarasztiaPeter requested a review from padamstx October 7, 2024 12:13

padamstx approved these changes Oct 7, 2024

View reviewed changes

padamstx merged commit 36d86ae into main Oct 7, 2024
4 checks passed

padamstx deleted the update-partnercentersellv1 branch October 7, 2024 15:20

ibm-devx-sdk added the released label Oct 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(Partner Center Sell): re-gen service after recent API definition changes #358

fix(Partner Center Sell): re-gen service after recent API definition changes #358

HarasztiaPeter commented Oct 2, 2024 •

edited

Loading

HarasztiaPeter commented Oct 2, 2024

HarasztiaPeter commented Oct 2, 2024

HarasztiaPeter commented Oct 2, 2024

padamstx Oct 2, 2024

HarasztiaPeter Oct 3, 2024

padamstx Oct 3, 2024

HarasztiaPeter Oct 4, 2024

padamstx Oct 2, 2024

HarasztiaPeter Oct 3, 2024 •

edited

Loading

padamstx Oct 3, 2024

padamstx Oct 3, 2024

HarasztiaPeter Oct 4, 2024

padamstx left a comment

This comment was marked as outdated.

padamstx left a comment

padamstx left a comment

HarasztiaPeter commented Oct 7, 2024

padamstx left a comment

ibm-devx-sdk commented Oct 7, 2024

fix(Partner Center Sell): re-gen service after recent API definition changes #358

fix(Partner Center Sell): re-gen service after recent API definition changes #358

Conversation

HarasztiaPeter commented Oct 2, 2024 • edited Loading

PR summary

PR Checklist

Current vs new behavior

Does this PR introduce a breaking change?

Other information

HarasztiaPeter commented Oct 2, 2024

HarasztiaPeter commented Oct 2, 2024

HarasztiaPeter commented Oct 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarasztiaPeter Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

padamstx left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

padamstx left a comment

Choose a reason for hiding this comment

padamstx left a comment

Choose a reason for hiding this comment

HarasztiaPeter commented Oct 7, 2024

padamstx left a comment

Choose a reason for hiding this comment

ibm-devx-sdk commented Oct 7, 2024

HarasztiaPeter commented Oct 2, 2024 •

edited

Loading

HarasztiaPeter Oct 3, 2024 •

edited

Loading