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.

Sign up for GitHub

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

feat(IBM Cloud Shell): re-gen service to adopt the new error toolchain #365

Merged
merged 1 commit into from
Nov 29, 2024
Merged

feat(IBM Cloud Shell): re-gen service to adopt the new error toolchain #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 66 additions & 18 deletions ibmcloudshellv1/ibm_cloud_shell_v1.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* (C) Copyright IBM Corp. 2021.
* (C) Copyright IBM Corp. 2024.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -15,7 +15,7 @@
*/

/*
* IBM OpenAPI SDK Code Generator Version: 3.33.0-caf29bd0-20210603-225214
* IBM OpenAPI SDK Code Generator Version: 3.96.1-5136e54a-20241108-203028
*/

// Package ibmcloudshellv1 : Operations and models for the IBMCloudShellV1 service
Expand All @@ -24,7 +24,6 @@ package ibmcloudshellv1
import (
"context"
"encoding/json"
"fmt"
"net/http"
"reflect"
"time"
Expand All @@ -35,7 +34,7 @@ import (

// IBMCloudShellV1 : API docs for IBM Cloud Shell repository
//
// Version: 1.0
// API Version: 1.0
type IBMCloudShellV1 struct {
Service *core.BaseService
}
Expand All @@ -62,22 +61,26 @@ func NewIBMCloudShellV1UsingExternalConfig(options *IBMCloudShellV1Options) (ibm
if options.Authenticator == nil {
options.Authenticator, err = core.GetAuthenticatorFromEnvironment(options.ServiceName)
if err != nil {
err = core.SDKErrorf(err, "", "env-auth-error", common.GetComponentInfo())
return
}
}

ibmCloudShell, err = NewIBMCloudShellV1(options)
err = core.RepurposeSDKProblem(err, "new-client-error")
if err != nil {
return
}

err = ibmCloudShell.Service.ConfigureService(options.ServiceName)
if err != nil {
err = core.SDKErrorf(err, "", "client-config-error", common.GetComponentInfo())
return
}

if options.URL != "" {
err = ibmCloudShell.Service.SetServiceURL(options.URL)
err = core.RepurposeSDKProblem(err, "url-set-error")
}
return
}
Expand All @@ -91,12 +94,14 @@ func NewIBMCloudShellV1(options *IBMCloudShellV1Options) (service *IBMCloudShell

baseService, err := core.NewBaseService(serviceOptions)
if err != nil {
err = core.SDKErrorf(err, "", "new-base-error", common.GetComponentInfo())
return
}

if options.URL != "" {
err = baseService.SetServiceURL(options.URL)
if err != nil {
err = core.SDKErrorf(err, "", "set-url-error", common.GetComponentInfo())
return
}
}
Expand All @@ -110,7 +115,7 @@ func NewIBMCloudShellV1(options *IBMCloudShellV1Options) (service *IBMCloudShell

// GetServiceURLForRegion returns the service URL to be used for the specified region
func GetServiceURLForRegion(region string) (string, error) {
return "", fmt.Errorf("service does not support regional URLs")
return "", core.SDKErrorf(nil, "service does not support regional URLs", "no-regional-support", common.GetComponentInfo())
}

// Clone makes a copy of "ibmCloudShell" suitable for processing requests.
Expand All @@ -125,7 +130,11 @@ func (ibmCloudShell *IBMCloudShellV1) Clone() *IBMCloudShellV1 {

// SetServiceURL sets the service URL
func (ibmCloudShell *IBMCloudShellV1) SetServiceURL(url string) error {
return ibmCloudShell.Service.SetServiceURL(url)
err := ibmCloudShell.Service.SetServiceURL(url)
if err != nil {
err = core.SDKErrorf(err, "", "url-set-error", common.GetComponentInfo())
}
return err
}

// GetServiceURL returns the service URL
Expand Down Expand Up @@ -165,17 +174,21 @@ func (ibmCloudShell *IBMCloudShellV1) DisableRetries() {
// be an account owner or users need to be assigned an IAM policy with the Administrator role for the Cloud Shell
// account management service.
func (ibmCloudShell *IBMCloudShellV1) GetAccountSettings(getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error) {
return ibmCloudShell.GetAccountSettingsWithContext(context.Background(), getAccountSettingsOptions)
result, response, err = ibmCloudShell.GetAccountSettingsWithContext(context.Background(), getAccountSettingsOptions)
err = core.RepurposeSDKProblem(err, "")
return
}

// GetAccountSettingsWithContext is an alternate form of the GetAccountSettings method which supports a Context parameter
func (ibmCloudShell *IBMCloudShellV1) GetAccountSettingsWithContext(ctx context.Context, getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error) {
err = core.ValidateNotNil(getAccountSettingsOptions, "getAccountSettingsOptions cannot be nil")
if err != nil {
err = core.SDKErrorf(err, "", "unexpected-nil-param", common.GetComponentInfo())
return
}
err = core.ValidateStruct(getAccountSettingsOptions, "getAccountSettingsOptions")
if err != nil {
err = core.SDKErrorf(err, "", "struct-validation-error", common.GetComponentInfo())
return
}

Expand All @@ -188,6 +201,7 @@ func (ibmCloudShell *IBMCloudShellV1) GetAccountSettingsWithContext(ctx context.
builder.EnableGzipCompression = ibmCloudShell.GetEnableGzipCompression()
_, err = builder.ResolveRequestURL(ibmCloudShell.Service.Options.URL, `/api/v1/user/accounts/{account_id}/settings`, pathParamsMap)
if err != nil {
err = core.SDKErrorf(err, "", "url-resolve-error", common.GetComponentInfo())
return
}

Expand All @@ -203,17 +217,21 @@ func (ibmCloudShell *IBMCloudShellV1) GetAccountSettingsWithContext(ctx context.

request, err := builder.Build()
if err != nil {
err = core.SDKErrorf(err, "", "build-error", common.GetComponentInfo())
return
}

var rawResponse map[string]json.RawMessage
response, err = ibmCloudShell.Service.Request(request, &rawResponse)
if err != nil {
core.EnrichHTTPProblem(err, "get_account_settings", getServiceComponentInfo())
err = core.SDKErrorf(err, "", "http-request-err", common.GetComponentInfo())
return
}
if rawResponse != nil {
err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalAccountSettings)
if err != nil {
err = core.SDKErrorf(err, "", "unmarshal-resp-error", common.GetComponentInfo())
return
}
response.Result = result
Expand All @@ -228,17 +246,21 @@ func (ibmCloudShell *IBMCloudShellV1) GetAccountSettingsWithContext(ctx context.
// settings, users need to be an account owner or users need to be assigned an IAM policy with the Administrator role
// for the Cloud Shell account management service.
func (ibmCloudShell *IBMCloudShellV1) UpdateAccountSettings(updateAccountSettingsOptions *UpdateAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error) {
return ibmCloudShell.UpdateAccountSettingsWithContext(context.Background(), updateAccountSettingsOptions)
result, response, err = ibmCloudShell.UpdateAccountSettingsWithContext(context.Background(), updateAccountSettingsOptions)
err = core.RepurposeSDKProblem(err, "")
return
}

// UpdateAccountSettingsWithContext is an alternate form of the UpdateAccountSettings method which supports a Context parameter
func (ibmCloudShell *IBMCloudShellV1) UpdateAccountSettingsWithContext(ctx context.Context, updateAccountSettingsOptions *UpdateAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error) {
err = core.ValidateNotNil(updateAccountSettingsOptions, "updateAccountSettingsOptions cannot be nil")
if err != nil {
err = core.SDKErrorf(err, "", "unexpected-nil-param", common.GetComponentInfo())
return
}
err = core.ValidateStruct(updateAccountSettingsOptions, "updateAccountSettingsOptions")
if err != nil {
err = core.SDKErrorf(err, "", "struct-validation-error", common.GetComponentInfo())
return
}

Expand All @@ -251,6 +273,7 @@ func (ibmCloudShell *IBMCloudShellV1) UpdateAccountSettingsWithContext(ctx conte
builder.EnableGzipCompression = ibmCloudShell.GetEnableGzipCompression()
_, err = builder.ResolveRequestURL(ibmCloudShell.Service.Options.URL, `/api/v1/user/accounts/{account_id}/settings`, pathParamsMap)
if err != nil {
err = core.SDKErrorf(err, "", "url-resolve-error", common.GetComponentInfo())
return
}

Expand Down Expand Up @@ -286,29 +309,37 @@ func (ibmCloudShell *IBMCloudShellV1) UpdateAccountSettingsWithContext(ctx conte
}
_, err = builder.SetBodyContentJSON(body)
if err != nil {
err = core.SDKErrorf(err, "", "set-json-body-error", common.GetComponentInfo())
return
}

request, err := builder.Build()
if err != nil {
err = core.SDKErrorf(err, "", "build-error", common.GetComponentInfo())
return
}

var rawResponse map[string]json.RawMessage
response, err = ibmCloudShell.Service.Request(request, &rawResponse)
if err != nil {
core.EnrichHTTPProblem(err, "update_account_settings", getServiceComponentInfo())
err = core.SDKErrorf(err, "", "http-request-err", common.GetComponentInfo())
return
}
if rawResponse != nil {
err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalAccountSettings)
if err != nil {
err = core.SDKErrorf(err, "", "unmarshal-resp-error", common.GetComponentInfo())
return
}
response.Result = result
}

return
}
func getServiceComponentInfo() *core.ProblemComponent {
return core.NewProblemComponent(DefaultServiceName, "1.0")
}

// AccountSettings : Definition of Cloud Shell account settings.
type AccountSettings struct {
Expand Down Expand Up @@ -359,54 +390,67 @@ func UnmarshalAccountSettings(m map[string]json.RawMessage, result interface{})
obj := new(AccountSettings)
err = core.UnmarshalPrimitive(m, "_id", &obj.ID)
if err != nil {
err = core.SDKErrorf(err, "", "_id-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "_rev", &obj.Rev)
if err != nil {
err = core.SDKErrorf(err, "", "_rev-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "account_id", &obj.AccountID)
if err != nil {
err = core.SDKErrorf(err, "", "account_id-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt)
if err != nil {
err = core.SDKErrorf(err, "", "created_at-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "created_by", &obj.CreatedBy)
if err != nil {
err = core.SDKErrorf(err, "", "created_by-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "default_enable_new_features", &obj.DefaultEnableNewFeatures)
if err != nil {
err = core.SDKErrorf(err, "", "default_enable_new_features-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "default_enable_new_regions", &obj.DefaultEnableNewRegions)
if err != nil {
err = core.SDKErrorf(err, "", "default_enable_new_regions-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled)
if err != nil {
err = core.SDKErrorf(err, "", "enabled-error", common.GetComponentInfo())
return
}
err = core.UnmarshalModel(m, "features", &obj.Features, UnmarshalFeature)
if err != nil {
err = core.SDKErrorf(err, "", "features-error", common.GetComponentInfo())
return
}
err = core.UnmarshalModel(m, "regions", &obj.Regions, UnmarshalRegionSetting)
if err != nil {
err = core.SDKErrorf(err, "", "regions-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "type", &obj.Type)
if err != nil {
err = core.SDKErrorf(err, "", "type-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt)
if err != nil {
err = core.SDKErrorf(err, "", "updated_at-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "updated_by", &obj.UpdatedBy)
if err != nil {
err = core.SDKErrorf(err, "", "updated_by-error", common.GetComponentInfo())
return
}
reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj))
Expand All @@ -427,10 +471,12 @@ func UnmarshalFeature(m map[string]json.RawMessage, result interface{}) (err err
obj := new(Feature)
err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled)
if err != nil {
err = core.SDKErrorf(err, "", "enabled-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "key", &obj.Key)
if err != nil {
err = core.SDKErrorf(err, "", "key-error", common.GetComponentInfo())
return
}
reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj))
Expand All @@ -440,9 +486,9 @@ func UnmarshalFeature(m map[string]json.RawMessage, result interface{}) (err err
// GetAccountSettingsOptions : The GetAccountSettings options.
type GetAccountSettingsOptions struct {
// The account ID in which the account settings belong to.
AccountID *string `validate:"required,ne="`
AccountID *string `json:"account_id" validate:"required,ne="`

// Allows users to set headers on API requests
// Allows users to set headers on API requests.
Headers map[string]string
}

Expand Down Expand Up @@ -479,10 +525,12 @@ func UnmarshalRegionSetting(m map[string]json.RawMessage, result interface{}) (e
obj := new(RegionSetting)
err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled)
if err != nil {
err = core.SDKErrorf(err, "", "enabled-error", common.GetComponentInfo())
return
}
err = core.UnmarshalPrimitive(m, "key", &obj.Key)
if err != nil {
err = core.SDKErrorf(err, "", "key-error", common.GetComponentInfo())
return
}
reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj))
Expand All @@ -492,29 +540,29 @@ func UnmarshalRegionSetting(m map[string]json.RawMessage, result interface{}) (e
// UpdateAccountSettingsOptions : The UpdateAccountSettings options.
type UpdateAccountSettingsOptions struct {
// The account ID in which the account settings belong to.
AccountID *string `validate:"required,ne="`
AccountID *string `json:"account_id" validate:"required,ne="`

// Unique revision number for the settings object.
Rev *string
Rev *string `json:"_rev,omitempty"`

// You can choose which Cloud Shell features are available in the account and whether any new features are enabled as
// they become available. The feature settings apply only to the enabled Cloud Shell locations.
DefaultEnableNewFeatures *bool
DefaultEnableNewFeatures *bool `json:"default_enable_new_features,omitempty"`

// Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and
// session data are stored. By default, users are routed to the nearest available location.
DefaultEnableNewRegions *bool
DefaultEnableNewRegions *bool `json:"default_enable_new_regions,omitempty"`

// When enabled, Cloud Shell is available to all users in the account.
Enabled *bool
Enabled *bool `json:"enabled,omitempty"`

// List of Cloud Shell features.
Features []Feature
Features []Feature `json:"features,omitempty"`

// List of Cloud Shell region settings.
Regions []RegionSetting
Regions []RegionSetting `json:"regions,omitempty"`

// Allows users to set headers on API requests
// Allows users to set headers on API requests.
Headers map[string]string
}

Expand Down
4 changes: 0 additions & 4 deletions ibmcloudshellv1/ibm_cloud_shell_v1_examples_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,6 @@ var _ = Describe(`IBMCloudShellV1 Examples Tests`, func() {
Enabled: core.BoolPtr(true),
Key: core.StringPtr("eu-de"),
},
{
Enabled: core.BoolPtr(true),
Key: core.StringPtr("jp-tok"),
},
pyrooka marked this conversation as resolved.
Show resolved Hide resolved
{
Enabled: core.BoolPtr(true),
Key: core.StringPtr("us-south"),
Expand Down
4 changes: 0 additions & 4 deletions ibmcloudshellv1/ibm_cloud_shell_v1_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,6 @@ var _ = Describe(`IBMCloudShellV1 Integration Tests`, func() {
Enabled: core.BoolPtr(true),
Key: core.StringPtr("eu-de"),
},
{
Enabled: core.BoolPtr(false),
Key: core.StringPtr("jp-tok"),
},
pyrooka marked this conversation as resolved.
Show resolved Hide resolved
{
Enabled: core.BoolPtr(false),
Key: core.StringPtr("us-south"),
Expand Down
2 changes: 1 addition & 1 deletion ibmcloudshellv1/ibm_cloud_shell_v1_suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* (C) Copyright IBM Corp. 2021.
* (C) Copyright IBM Corp. 2024.
pyrooka marked this conversation as resolved.
Show resolved Hide resolved
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Loading