Skip to content

Commit 88495f2

Browse files
committed
Fix: docs
1 parent 7d6314e commit 88495f2

File tree

8 files changed

+340
-66
lines changed

8 files changed

+340
-66
lines changed

coderd/apidoc/docs.go

Lines changed: 86 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

Lines changed: 76 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/provisionerdserver/provisionerdserver.go

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -649,18 +649,19 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
649649
return nil, xerrors.Errorf("marshal parameter options: %w", err)
650650
}
651651
_, err = server.Database.InsertTemplateVersionParameter(ctx, database.InsertTemplateVersionParameterParams{
652-
TemplateVersionID: input.TemplateVersionID,
653-
Name: richParameter.Name,
654-
Description: richParameter.Description,
655-
Type: richParameter.Type,
656-
Mutable: richParameter.Mutable,
657-
DefaultValue: richParameter.DefaultValue,
658-
Icon: richParameter.Icon,
659-
Options: options,
660-
ValidationRegex: richParameter.ValidationRegex,
661-
ValidationError: richParameter.ValidationError,
662-
ValidationMin: richParameter.ValidationMin,
663-
ValidationMax: richParameter.ValidationMax,
652+
TemplateVersionID: input.TemplateVersionID,
653+
Name: richParameter.Name,
654+
Description: richParameter.Description,
655+
Type: richParameter.Type,
656+
Mutable: richParameter.Mutable,
657+
DefaultValue: richParameter.DefaultValue,
658+
Icon: richParameter.Icon,
659+
Options: options,
660+
ValidationRegex: richParameter.ValidationRegex,
661+
ValidationError: richParameter.ValidationError,
662+
ValidationMin: richParameter.ValidationMin,
663+
ValidationMax: richParameter.ValidationMax,
664+
ValidationMonotonic: richParameter.ValidationMonotonic,
664665
})
665666
if err != nil {
666667
return nil, xerrors.Errorf("insert parameter: %w", err)

coderd/templateversions.go

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ func (api *API) templateVersionSchema(rw http.ResponseWriter, r *http.Request) {
199199
// @Produce json
200200
// @Tags Templates
201201
// @Param templateversion path string true "Template version ID" format(uuid)
202-
// @Success 200 {array} parameter.ComputedValue
202+
// @Success 200 {array} codersdk.TemplateVersionParameter
203203
// @Router /templateversions/{templateversion}/rich-parameters [get]
204204
func (api *API) templateVersionRichParameters(rw http.ResponseWriter, r *http.Request) {
205205
ctx := r.Context()
@@ -1459,17 +1459,18 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
14591459
})
14601460
}
14611461
return codersdk.TemplateVersionParameter{
1462-
Name: param.Name,
1463-
Description: param.Description,
1464-
Type: param.Type,
1465-
Mutable: param.Mutable,
1466-
DefaultValue: param.DefaultValue,
1467-
Icon: param.Icon,
1468-
Options: options,
1469-
ValidationRegex: param.ValidationRegex,
1470-
ValidationMin: param.ValidationMin,
1471-
ValidationMax: param.ValidationMax,
1472-
ValidationError: param.ValidationError,
1462+
Name: param.Name,
1463+
Description: param.Description,
1464+
Type: param.Type,
1465+
Mutable: param.Mutable,
1466+
DefaultValue: param.DefaultValue,
1467+
Icon: param.Icon,
1468+
Options: options,
1469+
ValidationRegex: param.ValidationRegex,
1470+
ValidationMin: param.ValidationMin,
1471+
ValidationMax: param.ValidationMax,
1472+
ValidationError: param.ValidationError,
1473+
ValidationMonotonic: codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
14731474
}, nil
14741475
}
14751476

codersdk/templateversions.go

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,18 @@ type TemplateVersion struct {
2424
CreatedBy User `json:"created_by"`
2525
}
2626

27+
type ValidationMonotonicOrder string
28+
29+
const (
30+
MonotonicOrderIncreasing ValidationMonotonicOrder = "increasing"
31+
MonotonicOrderDecreasing ValidationMonotonicOrder = "decreasing"
32+
)
33+
2734
// TemplateVersionParameter represents a parameter for a template version.
2835
type TemplateVersionParameter struct {
2936
Name string `json:"name"`
3037
Description string `json:"description"`
31-
Type string `json:"type"`
38+
Type string `json:"type" enums:"string,number,bool"`
3239
Mutable bool `json:"mutable"`
3340
DefaultValue string `json:"default_value"`
3441
Icon string `json:"icon"`
@@ -37,7 +44,7 @@ type TemplateVersionParameter struct {
3744
ValidationRegex string `json:"validation_regex"`
3845
ValidationMin int32 `json:"validation_min"`
3946
ValidationMax int32 `json:"validation_max"`
40-
ValidationMonotonic string `json:"validation_monotonic"`
47+
ValidationMonotonic ValidationMonotonicOrder `json:"validation_monotonic" enums:"increasing,decreasing"`
4148
}
4249

4350
// TemplateVersionParameterOption represents a selectable option for a template parameter.

0 commit comments

Comments
 (0)