feat(api): deployments

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 16
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-ff8ccba8b5409eaa1128df9027582cb63f66e8accd75e511f70b7c27ef26c9ae.yml
-openapi_spec_hash: 1dbacc339695a7c78718f90f791d3f01
+configured_endpoints: 17
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-2eeb61205775c5997abf8154cd6f6fe81a1e83870eff10050b17ed415aa7860b.yml
+openapi_spec_hash: 63405add4a3f53718f8183cbb8c1a22f
 config_hash: 00ec9df250b9dc077f8d3b93a442d252

api.md

@@ -14,12 +14,14 @@ Response Types:
 - <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentStateEvent">DeploymentStateEvent</a>
 - <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentNewResponse">DeploymentNewResponse</a>
 - <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentGetResponse">DeploymentGetResponse</a>
+- <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentListResponse">DeploymentListResponse</a>
 - <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentFollowResponseUnion">DeploymentFollowResponseUnion</a>
 
 Methods:
 
 - <code title="post /deployments">client.Deployments.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, body <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentNewParams">DeploymentNewParams</a>) (<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentNewResponse">DeploymentNewResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /deployments/{id}">client.Deployments.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, id <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentGetResponse">DeploymentGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="get /deployments">client.Deployments.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentListParams">DeploymentListParams</a>) ([]<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentListResponse">DeploymentListResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /deployments/{id}/events">client.Deployments.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentService.Follow">Follow</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, id <a href="https://pkg.go.dev/builtin#string">string</a>, query <a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentFollowParams">DeploymentFollowParams</a>) (<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk">kernel</a>.<a href="https://pkg.go.dev/github.com/onkernel/kernel-go-sdk#DeploymentFollowResponseUnion">DeploymentFollowResponseUnion</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 
 # Apps

app.go

@@ -13,6 +13,7 @@ import (
 	"github.com/onkernel/kernel-go-sdk/option"
 	"github.com/onkernel/kernel-go-sdk/packages/param"
 	"github.com/onkernel/kernel-go-sdk/packages/respjson"
+	"github.com/onkernel/kernel-go-sdk/shared"
 	"github.com/onkernel/kernel-go-sdk/shared/constant"
 )
 
@@ -49,24 +50,27 @@ func (r *AppService) List(ctx context.Context, query AppListParams, opts ...opti
 type AppListResponse struct {
 	// Unique identifier for the app version
 	ID string `json:"id,required"`
+	// List of actions available on the app
+	Actions []shared.AppAction `json:"actions,required"`
 	// Name of the application
 	AppName string `json:"app_name,required"`
 	// Deployment ID
 	Deployment string `json:"deployment,required"`
+	// Environment variables configured for this app version
+	EnvVars map[string]string `json:"env_vars,required"`
 	// Deployment region code
 	Region constant.AwsUsEast1a `json:"region,required"`
 	// Version label for the application
 	Version string `json:"version,required"`
-	// Environment variables configured for this app version
-	EnvVars map[string]string `json:"env_vars"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
 		ID          respjson.Field
+		Actions     respjson.Field
 		AppName     respjson.Field
 		Deployment  respjson.Field
+		EnvVars     respjson.Field
 		Region      respjson.Field
 		Version     respjson.Field
-		EnvVars     respjson.Field
 		ExtraFields map[string]respjson.Field
 		raw         string
 	} `json:"-"`

appdeployment.go

@@ -99,7 +99,7 @@ type AppDeploymentNewResponseApp struct {
 	// ID for the app version deployed
 	ID string `json:"id,required"`
 	// List of actions available on the app
-	Actions []AppDeploymentNewResponseAppAction `json:"actions,required"`
+	Actions []shared.AppAction `json:"actions,required"`
 	// Name of the app
 	Name string `json:"name,required"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
@@ -118,23 +118,6 @@ func (r *AppDeploymentNewResponseApp) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
-type AppDeploymentNewResponseAppAction struct {
-	// Name of the action
-	Name string `json:"name,required"`
-	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
-	JSON struct {
-		Name        respjson.Field
-		ExtraFields map[string]respjson.Field
-		raw         string
-	} `json:"-"`
-}
-
-// Returns the unmodified JSON received from the API
-func (r AppDeploymentNewResponseAppAction) RawJSON() string { return r.JSON.raw }
-func (r *AppDeploymentNewResponseAppAction) UnmarshalJSON(data []byte) error {
-	return apijson.UnmarshalRoot(data, r)
-}
-
 // Current status of the deployment
 type AppDeploymentNewResponseStatus string
 

deployment.go

@@ -65,6 +65,14 @@ func (r *DeploymentService) Get(ctx context.Context, id string, opts ...option.R
 	return
 }
 
+// List deployments. Optionally filter by application name.
+func (r *DeploymentService) List(ctx context.Context, query DeploymentListParams, opts ...option.RequestOption) (res *[]DeploymentListResponse, err error) {
+	opts = append(r.Options[:], opts...)
+	path := "deployments"
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
+	return
+}
+
 // Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and
 // status updates for a deployment. The stream terminates automatically once the
 // deployment reaches a terminal state.
@@ -253,6 +261,58 @@ const (
 	DeploymentGetResponseStatusStopped    DeploymentGetResponseStatus = "stopped"
 )
 
+// Deployment record information.
+type DeploymentListResponse struct {
+	// Unique identifier for the deployment
+	ID string `json:"id,required"`
+	// Timestamp when the deployment was created
+	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
+	// Deployment region code
+	Region constant.AwsUsEast1a `json:"region,required"`
+	// Current status of the deployment
+	//
+	// Any of "queued", "in_progress", "running", "failed", "stopped".
+	Status DeploymentListResponseStatus `json:"status,required"`
+	// Relative path to the application entrypoint
+	EntrypointRelPath string `json:"entrypoint_rel_path"`
+	// Environment variables configured for this deployment
+	EnvVars map[string]string `json:"env_vars"`
+	// Status reason
+	StatusReason string `json:"status_reason"`
+	// Timestamp when the deployment was last updated
+	UpdatedAt time.Time `json:"updated_at,nullable" format:"date-time"`
+	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
+	JSON struct {
+		ID                respjson.Field
+		CreatedAt         respjson.Field
+		Region            respjson.Field
+		Status            respjson.Field
+		EntrypointRelPath respjson.Field
+		EnvVars           respjson.Field
+		StatusReason      respjson.Field
+		UpdatedAt         respjson.Field
+		ExtraFields       map[string]respjson.Field
+		raw               string
+	} `json:"-"`
+}
+
+// Returns the unmodified JSON received from the API
+func (r DeploymentListResponse) RawJSON() string { return r.JSON.raw }
+func (r *DeploymentListResponse) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+// Current status of the deployment
+type DeploymentListResponseStatus string
+
+const (
+	DeploymentListResponseStatusQueued     DeploymentListResponseStatus = "queued"
+	DeploymentListResponseStatusInProgress DeploymentListResponseStatus = "in_progress"
+	DeploymentListResponseStatusRunning    DeploymentListResponseStatus = "running"
+	DeploymentListResponseStatusFailed     DeploymentListResponseStatus = "failed"
+	DeploymentListResponseStatusStopped    DeploymentListResponseStatus = "stopped"
+)
+
 // DeploymentFollowResponseUnion contains all possible properties and values from
 // [shared.LogEvent], [DeploymentStateEvent],
 // [DeploymentFollowResponseAppVersionSummaryEvent], [shared.ErrorEvent],
@@ -414,6 +474,20 @@ const (
 	DeploymentNewParamsRegionAwsUsEast1a DeploymentNewParamsRegion = "aws.us-east-1a"
 )
 
+type DeploymentListParams struct {
+	// Filter results by application name.
+	AppName param.Opt[string] `query:"app_name,omitzero" json:"-"`
+	paramObj
+}
+
+// URLQuery serializes [DeploymentListParams]'s query parameters as `url.Values`.
+func (r DeploymentListParams) URLQuery() (v url.Values, err error) {
+	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
+		ArrayFormat:  apiquery.ArrayQueryFormatComma,
+		NestedFormat: apiquery.NestedQueryFormatBrackets,
+	})
+}
+
 type DeploymentFollowParams struct {
 	// Show logs since the given time (RFC timestamps or durations like 5m).
 	Since param.Opt[string] `query:"since,omitzero" json:"-"`

deployment_test.go

@@ -69,3 +69,28 @@ func TestDeploymentGet(t *testing.T) {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
 }
+
+func TestDeploymentListWithOptionalParams(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 := kernel.NewClient(
+		option.WithBaseURL(baseURL),
+		option.WithAPIKey("My API Key"),
+	)
+	_, err := client.Deployments.List(context.TODO(), kernel.DeploymentListParams{
+		AppName: kernel.String("app_name"),
+	})
+	if err != nil {
+		var apierr *kernel.Error
+		if errors.As(err, &apierr) {
+			t.Log(string(apierr.DumpRequest(true)))
+		}
+		t.Fatalf("err should be nil: %s", err.Error())
+	}
+}