-
Notifications
You must be signed in to change notification settings - Fork 7
/
api.go
61 lines (50 loc) · 2.38 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
Copyright 2020 GramLabs, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1alpha1
import (
"context"
"github.com/thestormforge/optimize-go/pkg/api"
)
const (
ErrExperimentNameInvalid api.ErrorType = "experiment-name-invalid"
ErrExperimentNameConflict api.ErrorType = "experiment-name-conflict"
ErrExperimentInvalid api.ErrorType = "experiment-invalid"
ErrExperimentNotFound api.ErrorType = "experiment-not-found"
ErrExperimentStopped api.ErrorType = "experiment-stopped"
ErrTrialInvalid api.ErrorType = "trial-invalid"
ErrTrialUnavailable api.ErrorType = "trial-unavailable"
ErrTrialNotFound api.ErrorType = "trial-not-found"
ErrTrialAlreadyReported api.ErrorType = "trial-already-reported"
)
type Server struct {
api.Metadata `json:"-"`
}
// API provides bindings for the supported endpoints
type API interface {
// CheckEndpoint verifies we can talk to the backend.
CheckEndpoint(ctx context.Context) (api.Metadata, error)
GetAllExperiments(context.Context, ExperimentListQuery) (ExperimentList, error)
GetAllExperimentsByPage(context.Context, string) (ExperimentList, error)
GetExperimentByName(context.Context, ExperimentName) (Experiment, error)
GetExperiment(context.Context, string) (Experiment, error)
CreateExperimentByName(context.Context, ExperimentName, Experiment) (Experiment, error)
CreateExperiment(context.Context, string, Experiment) (Experiment, error)
DeleteExperiment(context.Context, string) error
LabelExperiment(context.Context, string, ExperimentLabels) error
GetAllTrials(context.Context, string, TrialListQuery) (TrialList, error)
CreateTrial(context.Context, string, TrialAssignments) (TrialAssignments, error)
NextTrial(context.Context, string) (TrialAssignments, error)
ReportTrial(context.Context, string, TrialValues) error
AbandonRunningTrial(context.Context, string) error
LabelTrial(context.Context, string, TrialLabels) error
}