Merge pull request #9 from hdresearch/release-please--branches--main--changes--next

parth-agrawal · web-flow · commit 1a929173d9d0 · 2025-04-03T15:18:44.000-04:00
release: 0.1.0-alpha.3
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.2"
+  ".": "0.1.0-alpha.3"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
-configured_endpoints: 9
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hdr-parth-agrawal%2Ffirecracker-manager-5abc6ae5528da145dff4c50ea70cce67638d737cc5d67ed39fed93b30032053f.yml
-openapi_spec_hash: 718f1d7cd3862c03d0a700489a29b902
-config_hash: 42b27355c32dc9b2891e7c07c1a80ab2
+configured_endpoints: 10
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hdr-parth-agrawal%2Ffirecracker-manager-b0e551d58b1c9c3a43b42d8d5866bba7dce7125f1dce627eedf8457ed581e8d8.yml
+openapi_spec_hash: 9a86633a5456bb4290242dc28d6f1774
+config_hash: ed897099634e5370025375b19f936397
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.3 (2025-04-03)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/hdresearch/vers-sdk-go/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* **api:** update via SDK Studio ([#8](https://github.com/hdresearch/vers-sdk-go/issues/8)) ([b0abc42](https://github.com/hdresearch/vers-sdk-go/commit/b0abc42f2718f586cdcea385c19160724a687ef1))
+
 ## 0.1.0-alpha.2 (2025-04-03)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/hdresearch/vers-sdk-go/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/hdresearch/vers-sdk-go@v0.1.0-alpha.2'
+go get -u 'github.com/hdresearch/vers-sdk-go@v0.1.0-alpha.3'
 ```
 
 <!-- x-release-please-end -->
diff --git a/api.md b/api.md
@@ -18,6 +18,7 @@ Methods:
 Response Types:
 
 - <a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#Vm">Vm</a>
+- <a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmExecuteResponse">APIVmExecuteResponse</a>
 
 Methods:
 
@@ -26,3 +27,4 @@ Methods:
 - <code title="get /api/vm">client.API.Vm.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>) ([]<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#Vm">Vm</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="delete /api/vm/{vm_id}">client.API.Vm.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmService.Delete">Delete</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, vmID <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmDeleteParams">APIVmDeleteParams</a>) <a href="https://pkg.go.dev/builtin#error">error</a></code>
 - <code title="post /api/vm/{vm_id}/branch">client.API.Vm.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmService.NewBranch">NewBranch</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, vmID <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmNewBranchParams">APIVmNewBranchParams</a>) (<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#Vm">Vm</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="post /api/vm/{vm_id}/execute">client.API.Vm.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmService.Execute">Execute</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, vmID <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmExecuteParams">APIVmExecuteParams</a>) (<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go">vers</a>.<a href="https://pkg.go.dev/github.com/hdresearch/vers-sdk-go#APIVmExecuteResponse">APIVmExecuteResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
diff --git a/apivm.go b/apivm.go
@@ -94,6 +94,17 @@ func (r *APIVmService) NewBranch(ctx context.Context, vmID string, body APIVmNew
 	return
 }
 
+func (r *APIVmService) Execute(ctx context.Context, vmID string, body APIVmExecuteParams, opts ...option.RequestOption) (res *APIVmExecuteResponse, err error) {
+	opts = append(r.Options[:], opts...)
+	if vmID == "" {
+		err = errors.New("missing required vm_id parameter")
+		return
+	}
+	path := fmt.Sprintf("api/vm/%s/execute", vmID)
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
+	return
+}
+
 type Vm struct {
 	// The ID of the VM.
 	ID string `json:"id,required"`
@@ -176,6 +187,54 @@ func (r VmState) IsKnown() bool {
 	return false
 }
 
+type APIVmExecuteResponse struct {
+	ID            string                            `json:"id,required"`
+	CommandResult APIVmExecuteResponseCommandResult `json:"command_result,required"`
+	JSON          apiVmExecuteResponseJSON          `json:"-"`
+}
+
+// apiVmExecuteResponseJSON contains the JSON metadata for the struct
+// [APIVmExecuteResponse]
+type apiVmExecuteResponseJSON struct {
+	ID            apijson.Field
+	CommandResult apijson.Field
+	raw           string
+	ExtraFields   map[string]apijson.Field
+}
+
+func (r *APIVmExecuteResponse) UnmarshalJSON(data []byte) (err error) {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+func (r apiVmExecuteResponseJSON) RawJSON() string {
+	return r.raw
+}
+
+type APIVmExecuteResponseCommandResult struct {
+	ExitCode int64                                 `json:"exit_code,required"`
+	Stderr   string                                `json:"stderr,required"`
+	Stdout   string                                `json:"stdout,required"`
+	JSON     apiVmExecuteResponseCommandResultJSON `json:"-"`
+}
+
+// apiVmExecuteResponseCommandResultJSON contains the JSON metadata for the struct
+// [APIVmExecuteResponseCommandResult]
+type apiVmExecuteResponseCommandResultJSON struct {
+	ExitCode    apijson.Field
+	Stderr      apijson.Field
+	Stdout      apijson.Field
+	raw         string
+	ExtraFields map[string]apijson.Field
+}
+
+func (r *APIVmExecuteResponseCommandResult) UnmarshalJSON(data []byte) (err error) {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+func (r apiVmExecuteResponseCommandResultJSON) RawJSON() string {
+	return r.raw
+}
+
 type APIVmUpdateParams struct {
 	Body APIVmUpdateParamsBody `json:"body,required"`
 }
@@ -219,3 +278,11 @@ type APIVmNewBranchParams struct {
 func (r APIVmNewBranchParams) MarshalJSON() (data []byte, err error) {
 	return apijson.MarshalRoot(r.Body)
 }
+
+type APIVmExecuteParams struct {
+	Command param.Field[string] `json:"command,required"`
+}
+
+func (r APIVmExecuteParams) MarshalJSON() (data []byte, err error) {
+	return apijson.MarshalRoot(r)
+}
diff --git a/apivm_test.go b/apivm_test.go
@@ -145,3 +145,32 @@ func TestAPIVmNewBranch(t *testing.T) {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
 }
+
+func TestAPIVmExecute(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
+	baseURL := "http://localhost:4010"
+	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
+		baseURL = envURL
+	}
+	if !testutil.CheckTestServer(t, baseURL) {
+		return
+	}
+	client := vers.NewClient(
+		option.WithBaseURL(baseURL),
+		option.WithAPIKey("My API Key"),
+	)
+	_, err := client.API.Vm.Execute(
+		context.TODO(),
+		"vm_id",
+		vers.APIVmExecuteParams{
+			Command: vers.F("command"),
+		},
+	)
+	if err != nil {
+		var apierr *vers.Error
+		if errors.As(err, &apierr) {
+			t.Log(string(apierr.DumpRequest(true)))
+		}
+		t.Fatalf("err should be nil: %s", err.Error())
+	}
+}
diff --git a/internal/version.go b/internal/version.go
@@ -2,4 +2,4 @@
 
 package internal
 
-const PackageVersion = "0.1.0-alpha.2" // x-release-please-version
+const PackageVersion = "0.1.0-alpha.3" // x-release-please-version

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.1.0-alpha.2"`
	`2`	`+ ".": "0.1.0-alpha.3"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`package internal`
`4`	`4`
`5`		`-const PackageVersion = "0.1.0-alpha.2" // x-release-please-version`
	`5`	`+const PackageVersion = "0.1.0-alpha.3" // x-release-please-version`