release: 0.1.0-alpha.4

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ jobs:
     timeout-minutes: 10
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/gbox-sdk-go' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
 
     steps:
       - uses: actions/checkout@v4
@@ -32,6 +33,7 @@ jobs:
     timeout-minutes: 10
     name: test
     runs-on: ${{ github.repository == 'stainless-sdks/gbox-sdk-go' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.3"
+  ".": "0.1.0-alpha.4"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 38
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gbox%2Fgbox-sdk-21b86f090470f516255171dcb8e840c5cde51529f50fe1cf91d8f3d5e299588d.yml
-openapi_spec_hash: fcc2bd33fc48cb903008804b908deceb
-config_hash: a5110c90220411b677136bb0447870d8
+configured_endpoints: 93
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gbox%2Fgbox-sdk-f635173eacab4cd113f0f0d93fbe7c54cfc8878da547f2569fd2347deac8d1eb.yml
+openapi_spec_hash: 45881a4a8bcb3ee80eba3b99148e4edc
+config_hash: 09531a3b47b37eecfb541e383d99e62c

CONTRIBUTING.md

@@ -9,7 +9,7 @@ $ ./scripts/lint
 
 This will install all the required dependencies and build the SDK.
 
-You can also [install go 1.18+ manually](https://go.dev/doc/install).
+You can also [install go 1.22+ manually](https://go.dev/doc/install).
 
 ## Modifying/Adding code
 

README.md

@@ -1,7 +1,11 @@
 # Gbox Client Go API Library
 
+<!-- x-release-please-start-version -->
+
 <a href="https://pkg.go.dev/github.com/babelcloud/gbox-sdk-go"><img src="https://pkg.go.dev/badge/github.com/babelcloud/gbox-sdk-go.svg" alt="Go Reference"></a>
 
+<!-- x-release-please-end -->
+
 The Gbox Client Go library provides convenient access to the Gbox Client REST API
 from applications written in Go.
 
@@ -24,14 +28,14 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/babelcloud/[email protected].3'
+go get -u 'github.com/babelcloud/[email protected].4'
 ```
 
 <!-- x-release-please-end -->
 
 ## Requirements
 
-This library requires Go 1.18+.
+This library requires Go 1.22+.
 
 ## Usage
 
@@ -50,8 +54,8 @@ import (
 
 func main() {
 	client := gboxsdk.NewClient(
-		option.WithAPIKey("My API Key"),  // defaults to os.LookupEnv("GBOX_API_KEY")
-		option.WithEnvironmentSelfHost(), // defaults to option.WithEnvironmentProduction()
+		option.WithAPIKey("My API Key"),     // defaults to os.LookupEnv("GBOX_API_KEY")
+		option.WithEnvironmentSelfHosting(), // or option.WithEnvironmentProduction() | option.WithEnvironmentInternal(); defaults to option.WithEnvironmentProduction()
 	)
 	androidBox, err := client.V1.Boxes.NewAndroid(context.TODO(), gboxsdk.V1BoxNewAndroidParams{
 		CreateAndroidBox: gboxsdk.CreateAndroidBoxParam{},
@@ -350,24 +354,27 @@ which can be used to wrap any `io.Reader` with the appropriate file name and con
 ```go
 // A file from the file system
 file, err := os.Open("/path/to/file")
-gboxsdk.V1BoxAndroidInstallParamsInstallAndroidAppByFile{
-	Apk: file,
+gboxsdk.V1BoxFWriteParamsWriteFileByBinary{
+	Content: file,
+	Path:    "/home/user/documents/output.txt",
 }
 
 // A file from a string
-gboxsdk.V1BoxAndroidInstallParamsInstallAndroidAppByFile{
-	Apk: strings.NewReader("my file contents"),
+gboxsdk.V1BoxFWriteParamsWriteFileByBinary{
+	Content: strings.NewReader("my file contents"),
+	Path:    "/home/user/documents/output.txt",
 }
 
 // With a custom filename and contentType
-gboxsdk.V1BoxAndroidInstallParamsInstallAndroidAppByFile{
-	Apk: gboxsdk.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),
+gboxsdk.V1BoxFWriteParamsWriteFileByBinary{
+	Content: gboxsdk.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),
+	Path:    "/home/user/documents/output.txt",
 }
 ```
 
 ### Retries
 
-Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+Certain errors will be automatically retried 0 times by default, with a short exponential backoff.
 We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,
 and >=500 Internal errors.
 

client.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"net/http"
 	"os"
+	"slices"
 
 	"github.com/babelcloud/gbox-sdk-go/internal/requestconfig"
 	"github.com/babelcloud/gbox-sdk-go/option"
@@ -78,7 +79,7 @@ func NewClient(opts ...option.RequestOption) (r Client) {
 // For even greater flexibility, see [option.WithResponseInto] and
 // [option.WithResponseBodyInto].
 func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, opts ...option.RequestOption) error {
-	opts = append(r.Options, opts...)
+	opts = slices.Concat(r.Options, opts)
 	return requestconfig.ExecuteNewRequest(ctx, method, path, params, res, opts...)
 }
 

client_test.go

@@ -74,11 +74,11 @@ func TestRetryAfter(t *testing.T) {
 	}
 
 	attempts := len(retryCountHeaders)
-	if attempts != 3 {
-		t.Errorf("Expected %d attempts, got %d", 3, attempts)
+	if attempts != 1 {
+		t.Errorf("Expected %d attempts, got %d", 1, attempts)
 	}
 
-	expectedRetryCountHeaders := []string{"0", "1", "2"}
+	expectedRetryCountHeaders := []string{"0"}
 	if !reflect.DeepEqual(retryCountHeaders, expectedRetryCountHeaders) {
 		t.Errorf("Expected %v retry count headers, got %v", expectedRetryCountHeaders, retryCountHeaders)
 	}
@@ -111,7 +111,7 @@ func TestDeleteRetryCountHeader(t *testing.T) {
 		t.Error("Expected there to be a cancel error")
 	}
 
-	expectedRetryCountHeaders := []string{"", "", ""}
+	expectedRetryCountHeaders := []string{""}
 	if !reflect.DeepEqual(retryCountHeaders, expectedRetryCountHeaders) {
 		t.Errorf("Expected %v retry count headers, got %v", expectedRetryCountHeaders, retryCountHeaders)
 	}
@@ -144,7 +144,7 @@ func TestOverwriteRetryCountHeader(t *testing.T) {
 		t.Error("Expected there to be a cancel error")
 	}
 
-	expectedRetryCountHeaders := []string{"42", "42", "42"}
+	expectedRetryCountHeaders := []string{"42"}
 	if !reflect.DeepEqual(retryCountHeaders, expectedRetryCountHeaders) {
 		t.Errorf("Expected %v retry count headers, got %v", expectedRetryCountHeaders, retryCountHeaders)
 	}
@@ -175,7 +175,7 @@ func TestRetryAfterMs(t *testing.T) {
 	if err == nil {
 		t.Error("Expected there to be a cancel error")
 	}
-	if want := 3; attempts != want {
+	if want := 1; attempts != want {
 		t.Errorf("Expected %d attempts, got %d", want, attempts)
 	}
 }

go.mod

@@ -1,6 +1,6 @@
 module github.com/babelcloud/gbox-sdk-go
 
-go 1.21
+go 1.22
 
 require (
 	github.com/tidwall/gjson v1.14.4

internal/apijson/decodeparam_test.go

@@ -351,6 +351,36 @@ func init() {
 	})
 }
 
+type FooVariant struct {
+	Type  string `json:"type,required"`
+	Value string `json:"value,required"`
+}
+
+type BarVariant struct {
+	Type   string `json:"type,required"`
+	Enable bool   `json:"enable,required"`
+}
+
+type MultiDiscriminatorUnion struct {
+	OfFoo *FooVariant `json:",inline"`
+	OfBar *BarVariant `json:",inline"`
+
+	paramUnion
+}
+
+func init() {
+	apijson.RegisterDiscriminatedUnion[MultiDiscriminatorUnion]("type", map[string]reflect.Type{
+		"foo":        reflect.TypeOf(FooVariant{}),
+		"foo_v2":     reflect.TypeOf(FooVariant{}),
+		"bar":        reflect.TypeOf(BarVariant{}),
+		"bar_legacy": reflect.TypeOf(BarVariant{}),
+	})
+}
+
+func (m *MultiDiscriminatorUnion) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, m)
+}
+
 func (d *DiscriminatedUnion) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, d)
 }
@@ -408,3 +438,61 @@ func TestDiscriminatedUnion(t *testing.T) {
 		})
 	}
 }
+
+func TestMultiDiscriminatorUnion(t *testing.T) {
+	tests := map[string]struct {
+		raw        string
+		target     MultiDiscriminatorUnion
+		shouldFail bool
+	}{
+		"foo_variant": {
+			raw: `{"type":"foo","value":"test"}`,
+			target: MultiDiscriminatorUnion{OfFoo: &FooVariant{
+				Type:  "foo",
+				Value: "test",
+			}},
+		},
+		"foo_v2_variant": {
+			raw: `{"type":"foo_v2","value":"test_v2"}`,
+			target: MultiDiscriminatorUnion{OfFoo: &FooVariant{
+				Type:  "foo_v2",
+				Value: "test_v2",
+			}},
+		},
+		"bar_variant": {
+			raw: `{"type":"bar","enable":true}`,
+			target: MultiDiscriminatorUnion{OfBar: &BarVariant{
+				Type:   "bar",
+				Enable: true,
+			}},
+		},
+		"bar_legacy_variant": {
+			raw: `{"type":"bar_legacy","enable":false}`,
+			target: MultiDiscriminatorUnion{OfBar: &BarVariant{
+				Type:   "bar_legacy",
+				Enable: false,
+			}},
+		},
+		"invalid_type": {
+			raw:        `{"type":"unknown","value":"test"}`,
+			target:     MultiDiscriminatorUnion{},
+			shouldFail: true,
+		},
+	}
+
+	for name, test := range tests {
+		t.Run(name, func(t *testing.T) {
+			var dst MultiDiscriminatorUnion
+			err := json.Unmarshal([]byte(test.raw), &dst)
+			if err != nil && !test.shouldFail {
+				t.Fatalf("failed unmarshal with err: %v", err)
+			}
+			if err == nil && test.shouldFail {
+				t.Fatalf("expected unmarshal to fail but it succeeded")
+			}
+			if !reflect.DeepEqual(dst, test.target) {
+				t.Fatalf("failed equality, got %#v but expected %#v", dst, test.target)
+			}
+		})
+	}
+}

internal/apijson/encoder.go

@@ -16,6 +16,10 @@ import (
 
 var encoders sync.Map // map[encoderEntry]encoderFunc
 
+// If we want to set a literal key value into JSON using sjson, we need to make sure it doesn't have
+// special characters that sjson interprets as a path.
+var EscapeSJSONKey = strings.NewReplacer("\\", "\\\\", "|", "\\|", "#", "\\#", "@", "\\@", "*", "\\*", ".", "\\.", ":", "\\:", "?", "\\?").Replace
+
 func Marshal(value any) ([]byte, error) {
 	e := &encoder{dateFormat: time.RFC3339}
 	return e.marshal(value)
@@ -270,7 +274,7 @@ func (e *encoder) newStructTypeEncoder(t reflect.Type) encoderFunc {
 			if encoded == nil {
 				continue
 			}
-			json, err = sjson.SetRawBytes(json, ef.tag.name, encoded)
+			json, err = sjson.SetRawBytes(json, EscapeSJSONKey(ef.tag.name), encoded)
 			if err != nil {
 				return nil, err
 			}
@@ -348,7 +352,7 @@ func (e *encoder) encodeMapEntries(json []byte, v reflect.Value) ([]byte, error)
 			}
 			encodedKeyString = string(encodedKeyBytes)
 		}
-		encodedKey := []byte(sjsonReplacer.Replace(encodedKeyString))
+		encodedKey := []byte(encodedKeyString)
 		pairs = append(pairs, mapPair{key: encodedKey, value: iter.Value()})
 	}
 
@@ -366,7 +370,7 @@ func (e *encoder) encodeMapEntries(json []byte, v reflect.Value) ([]byte, error)
 		if len(encodedValue) == 0 {
 			continue
 		}
-		json, err = sjson.SetRawBytes(json, string(p.key), encodedValue)
+		json, err = sjson.SetRawBytes(json, EscapeSJSONKey(string(p.key)), encodedValue)
 		if err != nil {
 			return nil, err
 		}
@@ -386,7 +390,3 @@ func (e *encoder) newMapEncoder(_ reflect.Type) encoderFunc {
 		return json, nil
 	}
 }
-
-// If we want to set a literal key value into JSON using sjson, we need to make sure it doesn't have
-// special characters that sjson interprets as a path.
-var sjsonReplacer *strings.Replacer = strings.NewReplacer(".", "\\.", ":", "\\:", "*", "\\*")