Skip to content

feat: add rich parameters #4311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 18 commits into from
Closed

feat: add rich parameters #4311

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
c7e8d4e
Add schema
kylecarbs Sep 29, 2022
c6cda84
Deprecate parse
kylecarbs Sep 29, 2022
d242523
Rename parameter routes to deprecated
kylecarbs Sep 29, 2022
e71711c
Add parameter parsing to builds
kylecarbs Sep 29, 2022
4cd5826
Add parameter parsing to the Terraform provider
kylecarbs Sep 30, 2022
120a70a
Add deprecated key to codersdk parameter values
kylecarbs Sep 30, 2022
a414314
Add new template parameter endpoint
kylecarbs Sep 30, 2022
bc6c788
Begin to integrate parameter validation
kylecarbs Sep 30, 2022
c85f7d2
Add new frontend for rendering parameters
kylecarbs Oct 2, 2022
5d9ac64
Add parameters to the create screen
kylecarbs Oct 2, 2022
1d934e8
Merge branch 'main' into parameter
kylecarbs Oct 2, 2022
b9dcfc3
Show parameters in the UI
kylecarbs Oct 3, 2022
367c913
Merge branch 'main' into parameter
kylecarbs Oct 25, 2022
022eec8
Add deprecated parameter schema
kylecarbs Oct 25, 2022
1e05960
Update deprecated parameter name in CLI
kylecarbs Oct 27, 2022
63572a5
Merge branch 'main' into parameter
kylecarbs Nov 5, 2022
51b3d47
Merge branch 'main' into parameter
kylecarbs Nov 30, 2022
a864d46
Fix some test things
kylecarbs Dec 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Rename parameter routes to deprecated
  • Loading branch information
@kylecarbs
kylecarbs committed Sep 29, 2022
commit d242523bebb046602b3bae1471fdcf566f641a5a
2 changes: 1 addition & 1 deletion cli/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWo
if err != nil {
return nil, err
}
parameterSchemas, err := client.TemplateVersionSchema(ctx, templateVersion.ID)
parameterSchemas, err := client.DeprecatedTemplateVersionSchema(ctx, templateVersion.ID)
if err != nil {
return nil, err
}
Expand Down
2 changes: 1 addition & 1 deletion cli/parameterslist.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func parameterList() *cobra.Command {
})
}

params, err := client.Parameters(cmd.Context(), codersdk.ParameterScope(scope), scopeID)
params, err := client.DeprecatedParameters(cmd.Context(), codersdk.ParameterScope(scope), scopeID)
if err != nil {
return xerrors.Errorf("fetch params: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions cli/templatecreate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,11 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
if err != nil {
return nil, nil, err
}
parameterSchemas, err := client.TemplateVersionSchema(cmd.Context(), version.ID)
parameterSchemas, err := client.DeprecatedTemplateVersionSchema(cmd.Context(), version.ID)
if err != nil {
return nil, nil, err
}
parameterValues, err := client.TemplateVersionParameters(cmd.Context(), version.ID)
parameterValues, err := client.DeprecatedTemplateVersionParameters(cmd.Context(), version.ID)
if err != nil {
return nil, nil, err
}
Expand All @@ -218,7 +218,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
}

// We don't want to compute the params, we only want to copy from this scope
values, err := client.Parameters(cmd.Context(), codersdk.ParameterImportJob, activeVersion.Job.ID)
values, err := client.DeprecatedParameters(cmd.Context(), codersdk.ParameterImportJob, activeVersion.Job.ID)
if err != nil {
return nil, nil, xerrors.Errorf("Fetch previous version parameters: %w", err)
}
Expand Down
2 changes: 1 addition & 1 deletion cli/templatepush_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ func latestTemplateVersion(t *testing.T, client *codersdk.Client, templateID uui
require.NoError(t, err)
tv, err := client.TemplateVersion(ctx, newTemplate.ActiveVersionID)
require.NoError(t, err)
params, err := client.Parameters(ctx, codersdk.ParameterImportJob, tv.Job.ID)
params, err := client.DeprecatedParameters(ctx, codersdk.ParameterImportJob, tv.Job.ID)
require.NoError(t, err)

return tv, params
Expand Down
2 changes: 1 addition & 1 deletion cli/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func update() *cobra.Command {

var existingParams []codersdk.Parameter
if !alwaysPrompt {
existingParams, err = client.Parameters(cmd.Context(), codersdk.ParameterWorkspace, workspace.ID)
existingParams, err = client.DeprecatedParameters(cmd.Context(), codersdk.ParameterWorkspace, workspace.ID)
if err != nil {
return nil
}
Expand Down
12 changes: 6 additions & 6 deletions coderd/coderd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,12 +305,12 @@ func New(options *Options) *API {
})
})
})
r.Route("/parameters/{scope}/{id}", func(r chi.Router) {
r.Route("/deprecated-parameters/{scope}/{id}", func(r chi.Router) {
r.Use(apiKeyMiddleware)
r.Post("/", api.postParameter)
r.Get("/", api.parameters)
r.Post("/", api.deprecatedPostParameter)
r.Get("/", api.deprecatedParameters)
r.Route("/{name}", func(r chi.Router) {
r.Delete("/", api.deleteParameter)
r.Delete("/", api.deprecatedDeleteParameter)
})
})
r.Route("/templates/{template}", func(r chi.Router) {
Expand All @@ -336,8 +336,8 @@ func New(options *Options) *API {

r.Get("/", api.templateVersion)
r.Patch("/cancel", api.patchCancelTemplateVersion)
r.Get("/schema", api.templateVersionSchema)
r.Get("/parameters", api.templateVersionParameters)
r.Get("/deprecated-schema", api.deprecatedTemplateVersionSchema)
r.Get("/deprecated-parameters", api.deprecatedTemplateVersionParameters)
r.Get("/resources", api.templateVersionResources)
r.Get("/logs", api.templateVersionLogs)
r.Route("/dry-run", func(r chi.Router) {
Expand Down
12 changes: 6 additions & 6 deletions coderd/coderdtest/authorize.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,15 +179,15 @@ func AGPLRoutes(a *AuthTester) (map[string]string, map[string]RouteCheck) {
AssertAction: rbac.ActionRead,
AssertObject: rbac.ResourceTemplate.InOrg(a.Template.OrganizationID),
},
"GET:/api/v2/templateversions/{templateversion}/parameters": {
"GET:/api/v2/templateversions/{templateversion}/deprecated-parameters": {
AssertAction: rbac.ActionRead,
AssertObject: rbac.ResourceTemplate.InOrg(a.Template.OrganizationID),
},
"GET:/api/v2/templateversions/{templateversion}/resources": {
AssertAction: rbac.ActionRead,
AssertObject: rbac.ResourceTemplate.InOrg(a.Template.OrganizationID),
},
"GET:/api/v2/templateversions/{templateversion}/schema": {
"GET:/api/v2/templateversions/{templateversion}/deprecated-schema": {
AssertAction: rbac.ActionRead,
AssertObject: rbac.ResourceTemplate.InOrg(a.Template.OrganizationID),
},
Expand Down Expand Up @@ -217,15 +217,15 @@ func AGPLRoutes(a *AuthTester) (map[string]string, map[string]RouteCheck) {
AssertObject: rbac.ResourceProvisionerDaemon,
},

"POST:/api/v2/parameters/{scope}/{id}": {
"POST:/api/v2/deprecated-parameters/{scope}/{id}": {
AssertAction: rbac.ActionUpdate,
AssertObject: rbac.ResourceTemplate,
},
"GET:/api/v2/parameters/{scope}/{id}": {
"GET:/api/v2/deprecated-parameters/{scope}/{id}": {
AssertAction: rbac.ActionRead,
AssertObject: rbac.ResourceTemplate,
},
"DELETE:/api/v2/parameters/{scope}/{id}/{name}": {
"DELETE:/api/v2/deprecated-parameters/{scope}/{id}/{name}": {
AssertAction: rbac.ActionUpdate,
AssertObject: rbac.ResourceTemplate,
},
Expand Down Expand Up @@ -358,7 +358,7 @@ func NewAuthTester(ctx context.Context, t *testing.T, client *codersdk.Client, a
})
require.NoError(t, err, "template version dry-run")

templateParam, err := client.CreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
templateParam, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
Name: "test-param",
SourceValue: "hello world",
SourceScheme: codersdk.ParameterSourceSchemeData,
Expand Down
6 changes: 3 additions & 3 deletions coderd/parameters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"github.com/coder/coder/codersdk"
)

func (api *API) postParameter(rw http.ResponseWriter, r *http.Request) {
func (api *API) deprecatedPostParameter(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
scope, scopeID, valid := readScopeAndID(ctx, rw, r)
if !valid {
Expand Down Expand Up @@ -78,7 +78,7 @@ func (api *API) postParameter(rw http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, rw, http.StatusCreated, convertParameterValue(parameterValue))
}

func (api *API) parameters(rw http.ResponseWriter, r *http.Request) {
func (api *API) deprecatedParameters(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
scope, scopeID, valid := readScopeAndID(ctx, rw, r)
if !valid {
Expand Down Expand Up @@ -116,7 +116,7 @@ func (api *API) parameters(rw http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, rw, http.StatusOK, apiParameterValues)
}

func (api *API) deleteParameter(rw http.ResponseWriter, r *http.Request) {
func (api *API) deprecatedDeleteParameter(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
scope, scopeID, valid := readScopeAndID(ctx, rw, r)
if !valid {
Expand Down
20 changes: 10 additions & 10 deletions coderd/parameters_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func TestPostParameter(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.CreateParameter(ctx, codersdk.ParameterScope("something"), user.OrganizationID, codersdk.CreateParameterRequest{
_, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterScope("something"), user.OrganizationID, codersdk.CreateParameterRequest{
Name: "example",
SourceValue: "tomato",
SourceScheme: codersdk.ParameterSourceSchemeData,
Expand All @@ -45,7 +45,7 @@ func TestPostParameter(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.CreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
_, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
Name: "example",
SourceValue: "tomato",
SourceScheme: codersdk.ParameterSourceSchemeData,
Expand All @@ -63,15 +63,15 @@ func TestPostParameter(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.CreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
_, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
Name: "example",
SourceValue: "tomato",
SourceScheme: codersdk.ParameterSourceSchemeData,
DestinationScheme: codersdk.ParameterDestinationSchemeProvisionerVariable,
})
require.NoError(t, err)

_, err = client.CreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
_, err = client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
Name: "example",
SourceValue: "tomato",
SourceScheme: codersdk.ParameterSourceSchemeData,
Expand All @@ -94,7 +94,7 @@ func TestParameters(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.Parameters(ctx, codersdk.ParameterTemplate, template.ID)
_, err := client.DeprecatedParameters(ctx, codersdk.ParameterTemplate, template.ID)
require.NoError(t, err)
})
t.Run("List", func(t *testing.T) {
Expand All @@ -106,14 +106,14 @@ func TestParameters(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.CreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
_, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
Name: "example",
SourceValue: "tomato",
SourceScheme: codersdk.ParameterSourceSchemeData,
DestinationScheme: codersdk.ParameterDestinationSchemeProvisionerVariable,
})
require.NoError(t, err)
params, err := client.Parameters(ctx, codersdk.ParameterTemplate, template.ID)
params, err := client.DeprecatedParameters(ctx, codersdk.ParameterTemplate, template.ID)
require.NoError(t, err)
require.Len(t, params, 1)
})
Expand All @@ -130,7 +130,7 @@ func TestDeleteParameter(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

err := client.DeleteParameter(ctx, codersdk.ParameterTemplate, template.ID, "something")
err := client.DeprecatedDeleteParameter(ctx, codersdk.ParameterTemplate, template.ID, "something")
var apiErr *codersdk.Error
require.ErrorAs(t, err, &apiErr)
require.Equal(t, http.StatusNotFound, apiErr.StatusCode())
Expand All @@ -144,14 +144,14 @@ func TestDeleteParameter(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

param, err := client.CreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
param, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
Name: "example",
SourceValue: "tomato",
SourceScheme: codersdk.ParameterSourceSchemeData,
DestinationScheme: codersdk.ParameterDestinationSchemeProvisionerVariable,
})
require.NoError(t, err)
err = client.DeleteParameter(ctx, codersdk.ParameterTemplate, template.ID, param.Name)
err = client.DeprecatedDeleteParameter(ctx, codersdk.ParameterTemplate, template.ID, param.Name)
require.NoError(t, err)
})
}
Expand Down
4 changes: 2 additions & 2 deletions coderd/templateversions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ func (api *API) patchCancelTemplateVersion(rw http.ResponseWriter, r *http.Reque
})
}

func (api *API) templateVersionSchema(rw http.ResponseWriter, r *http.Request) {
func (api *API) deprecatedTemplateVersionSchema(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
templateVersion := httpmw.TemplateVersionParam(r)
if !api.Authorize(r, rbac.ActionRead, templateVersion) {
Expand Down Expand Up @@ -146,7 +146,7 @@ func (api *API) templateVersionSchema(rw http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, rw, http.StatusOK, apiSchemas)
}

func (api *API) templateVersionParameters(rw http.ResponseWriter, r *http.Request) {
func (api *API) deprecatedTemplateVersionParameters(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
templateVersion := httpmw.TemplateVersionParam(r)
if !api.Authorize(r, rbac.ActionRead, templateVersion) {
Expand Down
10 changes: 5 additions & 5 deletions coderd/templateversions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ func TestTemplateVersionSchema(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.TemplateVersionSchema(ctx, version.ID)
_, err := client.DeprecatedTemplateVersionSchema(ctx, version.ID)
var apiErr *codersdk.Error
require.ErrorAs(t, err, &apiErr)
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
Expand All @@ -245,7 +245,7 @@ func TestTemplateVersionSchema(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

schemas, err := client.TemplateVersionSchema(ctx, version.ID)
schemas, err := client.DeprecatedTemplateVersionSchema(ctx, version.ID)
require.NoError(t, err)
require.NotNil(t, schemas)
require.Len(t, schemas, 1)
Expand Down Expand Up @@ -274,7 +274,7 @@ func TestTemplateVersionSchema(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

schemas, err := client.TemplateVersionSchema(ctx, version.ID)
schemas, err := client.DeprecatedTemplateVersionSchema(ctx, version.ID)
require.NoError(t, err)
require.NotNil(t, schemas)
require.Len(t, schemas, 1)
Expand All @@ -293,7 +293,7 @@ func TestTemplateVersionParameters(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

_, err := client.TemplateVersionParameters(ctx, version.ID)
_, err := client.DeprecatedTemplateVersionParameters(ctx, version.ID)
var apiErr *codersdk.Error
require.ErrorAs(t, err, &apiErr)
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
Expand Down Expand Up @@ -334,7 +334,7 @@ func TestTemplateVersionParameters(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

params, err := client.TemplateVersionParameters(ctx, version.ID)
params, err := client.DeprecatedTemplateVersionParameters(ctx, version.ID)
require.NoError(t, err)
require.NotNil(t, params)
require.Len(t, params, 2)
Expand Down
4 changes: 2 additions & 2 deletions coderd/users_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ func TestFirstUser(t *testing.T) {

for _, template := range templates {
// Check template parameters.
templateParams, err := client.Parameters(ctx, codersdk.ParameterTemplate, template.ID)
templateParams, err := client.DeprecatedParameters(ctx, codersdk.ParameterTemplate, template.ID)
require.NoErrorf(t, err, "get template parameters for %q", template.Name)

// Ensure all template parameters are present.
Expand Down Expand Up @@ -148,7 +148,7 @@ func TestFirstUser(t *testing.T) {
require.NoErrorf(t, err, "get template version for %q", template.Name)

// Compare job parameters to template parameters.
jobParams, err := client.Parameters(ctx, codersdk.ParameterImportJob, templateVersion.Job.ID)
jobParams, err := client.DeprecatedParameters(ctx, codersdk.ParameterImportJob, templateVersion.Job.ID)
require.NoErrorf(t, err, "get template import job parameters for %q", template.Name)
for _, v := range jobParams {
if _, ok := expectedParams[v.Name]; !ok {
Expand Down
12 changes: 6 additions & 6 deletions codersdk/parameters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ type CreateParameterRequest struct {
DestinationScheme ParameterDestinationScheme `json:"destination_scheme" validate:"oneof=environment_variable provisioner_variable,required"`
}

func (c *Client) CreateParameter(ctx context.Context, scope ParameterScope, id uuid.UUID, req CreateParameterRequest) (Parameter, error) {
res, err := c.Request(ctx, http.MethodPost, fmt.Sprintf("/api/v2/parameters/%s/%s", scope, id.String()), req)
func (c *Client) DeprecatedCreateParameter(ctx context.Context, scope ParameterScope, id uuid.UUID, req CreateParameterRequest) (Parameter, error) {
res, err := c.Request(ctx, http.MethodPost, fmt.Sprintf("/api/v2/deprecated-parameters/%s/%s", scope, id.String()), req)
if err != nil {
return Parameter{}, err
}
Expand All @@ -113,8 +113,8 @@ func (c *Client) CreateParameter(ctx context.Context, scope ParameterScope, id u
return param, json.NewDecoder(res.Body).Decode(&param)
}

func (c *Client) DeleteParameter(ctx context.Context, scope ParameterScope, id uuid.UUID, name string) error {
res, err := c.Request(ctx, http.MethodDelete, fmt.Sprintf("/api/v2/parameters/%s/%s/%s", scope, id.String(), name), nil)
func (c *Client) DeprecatedDeleteParameter(ctx context.Context, scope ParameterScope, id uuid.UUID, name string) error {
res, err := c.Request(ctx, http.MethodDelete, fmt.Sprintf("/api/v2/deprecated-parameters/%s/%s/%s", scope, id.String(), name), nil)
if err != nil {
return err
}
Expand All @@ -128,8 +128,8 @@ func (c *Client) DeleteParameter(ctx context.Context, scope ParameterScope, id u
return nil
}

func (c *Client) Parameters(ctx context.Context, scope ParameterScope, id uuid.UUID) ([]Parameter, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/parameters/%s/%s", scope, id.String()), nil)
func (c *Client) DeprecatedParameters(ctx context.Context, scope ParameterScope, id uuid.UUID) ([]Parameter, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/deprecated-parameters/%s/%s", scope, id.String()), nil)
if err != nil {
return nil, err
}
Expand Down
12 changes: 6 additions & 6 deletions codersdk/templateversions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ func (c *Client) CancelTemplateVersion(ctx context.Context, version uuid.UUID) e
return nil
}

// TemplateVersionSchema returns schemas for a template version by ID.
func (c *Client) TemplateVersionSchema(ctx context.Context, version uuid.UUID) ([]ParameterSchema, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/schema", version), nil)
// DeprecatedTemplateVersionSchema returns schemas for a template version by ID.
func (c *Client) DeprecatedTemplateVersionSchema(ctx context.Context, version uuid.UUID) ([]ParameterSchema, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/deprecated-schema", version), nil)
if err != nil {
return nil, err
}
Expand All @@ -66,9 +66,9 @@ func (c *Client) TemplateVersionSchema(ctx context.Context, version uuid.UUID) (
return params, json.NewDecoder(res.Body).Decode(&params)
}

// TemplateVersionParameters returns computed parameters for a template version.
func (c *Client) TemplateVersionParameters(ctx context.Context, version uuid.UUID) ([]ComputedParameter, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/parameters", version), nil)
// DeprecatedTemplateVersionParameters returns computed parameters for a template version.
func (c *Client) DeprecatedTemplateVersionParameters(ctx context.Context, version uuid.UUID) ([]ComputedParameter, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/deprecated-parameters", version), nil)
if err != nil {
return nil, err
}
Expand Down
2 changes: 1 addition & 1 deletion site/src/api/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ export const getTemplateVersionSchema = async (
versionId: string,
): Promise<TypesGen.ParameterSchema[]> => {
const response = await axios.get<TypesGen.ParameterSchema[]>(
`/api/v2/templateversions/${versionId}/schema`,
`/api/v2/templateversions/${versionId}/deprecated-schema`,
)
return response.data
}
Expand Down
Loading