docs: API deprecate returning config for bulk endpoints (#8732)

docs/release-notes/bulk-endpoint-experiment-config.rst

@@ -0,0 +1,9 @@
+:orphan:
+
+**Deprecated Features**
+
+-  API: The experiment API object in a future version will have its ``config`` field removed to
+   improve performance of the system. A new ``config`` field is added now to the response of
+   ``/api/v1/experiments/{experiment_id}`` that can be used as a replacement.
+
+   If you are not calling the APIs manually there will be no impact to you.

master/internal/api_experiment.go

@@ -336,8 +336,10 @@ func (a *apiServer) GetExperiment(
 		return nil, err
 	}
 
+	// Update this when we remove the proto type.
 	resp := apiv1.GetExperimentResponse{
 		Experiment: exp,
+		Config:     exp.Config, //nolint:staticcheck
 	}
 
 	// Only continue to add a job summary if it's an active experiment.
@@ -2686,6 +2688,8 @@ func (a *apiServer) SearchExperiments(
 			// Correct trial restarts because
 			// `restart` count is incremented before `restart <= max_restarts` stop restart check,
 			// so trials in terminal state have restarts = max + 1.
+			// Update this correction to happen in the database when we do the remove.
+			//nolint:staticcheck
 			configRestarts, ok := experiment.Config.Fields["max_restarts"].AsInterface().(float64)
 			if ok && trial.Restarts > int32(configRestarts) {
 				trial.Restarts = int32(configRestarts)

master/internal/api_experiment_intg_test.go

@@ -189,6 +189,34 @@ func TestGetExperimentLabels(t *testing.T) {
 	require.Subset(t, resp.Labels, labels)
 }
 
+func TestGetExperimentConfig(t *testing.T) {
+	api, curUser, ctx := setupAPITest(t, nil)
+
+	exp := createTestExp(t, api, curUser)
+	expectedBytes, err := db.SingleDB().ExperimentConfigRaw(exp.ID)
+	require.NoError(t, err)
+	expected := make(map[string]any)
+	require.NoError(t, json.Unmarshal(expectedBytes, &expected))
+
+	resp, err := api.GetExperiment(ctx, &apiv1.GetExperimentRequest{
+		ExperimentId: int32(exp.ID),
+	})
+	require.NoError(t, err)
+
+	cases := []struct {
+		name   string
+		config *structpb.Struct
+	}{
+		{"GetExperimentResponse.Config", resp.Config},
+		{"GetExperimentResponse.Experiment.Config", resp.Experiment.Config}, //nolint:staticcheck
+	}
+	for _, c := range cases {
+		t.Run(c.name, func(t *testing.T) {
+			require.Equal(t, expected, c.config.AsMap())
+		})
+	}
+}
+
 func TestGetTaskContextDirectoryExperiment(t *testing.T) {
 	api, curUser, ctx := setupAPITest(t, nil)
 
@@ -744,7 +772,7 @@ func getExperimentsTest(ctx context.Context, t *testing.T, api *apiServer, pid i
 		sort.Strings(res.Experiments[i].Labels)
 
 		// Don't compare config.
-		res.Experiments[i].Config = nil
+		res.Experiments[i].Config = nil //nolint:staticcheck
 
 		// Compare time seperatly due to millisecond precision in postgres.
 		require.WithinDuration(t,

master/pkg/model/experiment.go

@@ -371,6 +371,8 @@ func ExperimentFromProto(e *experimentv1.Experiment) (*Experiment, error) {
 		parentID = ptrs.Ptr(int(e.ForkedFrom.Value))
 	}
 
+	// Update this when we remove the proto type.
+	//nolint:staticcheck
 	byts, err := json.Marshal(e.Config)
 	if err != nil {
 		return nil, err