added new route for safe experiments

coder · Kira-Pilot · Oct 17, 2023 · Oct 15, 2023 · Oct 15, 2023 · Oct 15, 2023
commit 308dbb1bff3b689a3e1cdbe39de93707dde3cced
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -597,6 +597,7 @@ func New(options *Options) *API {
 		})
 		r.Route("/experiments", func(r chi.Router) {
 			r.Use(apiKeyMiddleware)
+			r.Get("/available", api.handleExperimentsSafe)
 			r.Get("/", api.handleExperimentsGet)
 		})
 		r.Get("/updatecheck", api.updateCheck)

diff --git a/coderd/experiments.go b/coderd/experiments.go
@@ -7,22 +7,28 @@ import (
 	"github.com/coder/coder/v2/codersdk"
 )
 
-// @Summary Get experiments
-// @ID get-experiments
+// @Summary Get enabled experiments
+// @ID get-enabled-experiments
 // @Security CoderSessionToken
 // @Produce json
 // @Tags General
-// @Param include_all query bool false "All available experiments"
 // @Success 200 {array} codersdk.Experiment
 // @Router /experiments [get]
 func (api *API) handleExperimentsGet(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
-	all := r.URL.Query().Has("include_all")
-
-	if !all {
-		httpapi.Write(ctx, rw, http.StatusOK, api.Experiments)
-		return
-	}
+	httpapi.Write(ctx, rw, http.StatusOK, api.Experiments)
+}
 
-	httpapi.Write(ctx, rw, http.StatusOK, codersdk.ExperimentsAll)
+// @Summary Get safe experiments
+// @ID get-safe-experiments
+// @Security CoderSessionToken
+// @Produce json
+// @Tags General
+// @Success 200 {array} codersdk.Experiment
+// @Router /experiments/available [get]
+func (api *API) handleExperimentsSafe(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	httpapi.Write(ctx, rw, http.StatusOK, codersdk.AvailableExperiments{
+		Safe: codersdk.ExperimentsAll,
+	})
 }
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -2029,26 +2029,27 @@ func (e Experiments) Enabled(ex Experiment) bool {
 	return false
 }
 
-type ExperimentOptions struct {
-	// All signifies that all experiments - rather than just those that are enabled -
-	// should be returned
-	IncludeAll bool `json:"include_all,omitempty"`
+func (c *Client) Experiments(ctx context.Context) (Experiments, error) {
+	res, err := c.Request(ctx, http.MethodGet, "/api/v2/experiments", nil)
+	if err != nil {
+		return nil, err
+	}
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusOK {
+		return nil, ReadBodyAsError(res)
+	}
+	var exp []Experiment
+	return exp, json.NewDecoder(res.Body).Decode(&exp)
 }
 
-// asRequestOption returns a function that can be used in (*Client).Request.
-// It modifies the request query parameters.
-func (o ExperimentOptions) asRequestOption() RequestOption {
-	return func(r *http.Request) {
-		q := r.URL.Query()
-		if o.IncludeAll {
-			q.Set("include_all", "true")
-		}
-		r.URL.RawQuery = q.Encode()
-	}
+// AvailableExperiments is an expandable type that returns all safe experiments
+// available to be used with a deployment.
+type AvailableExperiments struct {
+	Safe []Experiment `json:"safe"`
 }
 
-func (c *Client) Experiments(ctx context.Context, opts ExperimentOptions) (Experiments, error) {
-	res, err := c.Request(ctx, http.MethodGet, "/api/v2/experiments", nil, opts.asRequestOption())
+func (c *Client) SafeExperiments(ctx context.Context) (Experiments, error) {
+	res, err := c.Request(ctx, http.MethodGet, "/api/v2/experiments/available", nil)
 	if err != nil {
 		return nil, err
 	}

diff --git a/docs/api/general.md b/docs/api/general.md