mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: add GET /api/v2/templatebuilder/modules endpoint (#26117)
Implement `GET /api/v2/templatebuilder/modules`, which returns the filtered list of modules available for a given base template. Reads from the bundled catalog via `LoadModules()` and applies OS-compatibility filtering based on the `base` query param. Computed variables (e.g. `agent_id`) are excluded from the API response at the `ToSDK()` conversion boundary since they are wired automatically by the builder. The `Computed` field is removed from the SDK type. Adds `CompatibleWithOS()` to `ModuleManifest` for OS filtering. Returns 400 for unknown base IDs and 404 when the template builder is disabled. Depends on #26116 > [!NOTE] > This PR was authored by Coder Agents on behalf of @jeremyruppel.
This commit is contained in:
@@ -137,11 +137,31 @@ func parseModulesFromFS(fsys fs.FS) ([]ModuleManifest, error) {
|
||||
return modules, nil
|
||||
}
|
||||
|
||||
// CompatibleWithOS reports whether the module is compatible with the given OS.
|
||||
// Modules with an empty CompatibleOS list are compatible with all platforms.
|
||||
func (m ModuleManifest) CompatibleWithOS(os string) bool {
|
||||
if len(m.CompatibleOS) == 0 {
|
||||
return true
|
||||
}
|
||||
for _, supported := range m.CompatibleOS {
|
||||
if supported == os {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// ToSDK converts a ModuleManifest to the API response type.
|
||||
// PinnedVersion is mapped to Version; tags are not part of the API surface.
|
||||
// Computed variables are excluded from the output.
|
||||
func (m ModuleManifest) ToSDK() codersdk.TemplateBuilderModule {
|
||||
variables := make([]codersdk.TemplateBuilderModuleVariable, 0, len(m.Variables))
|
||||
for _, v := range m.Variables {
|
||||
// Computed variables (e.g. agent_id) are wired by the builder
|
||||
// automatically and must not be surfaced to the user.
|
||||
if v.Computed {
|
||||
continue
|
||||
}
|
||||
variables = append(variables, codersdk.TemplateBuilderModuleVariable{
|
||||
Name: v.Name,
|
||||
Type: validVariableTypes[v.Type],
|
||||
@@ -149,7 +169,6 @@ func (m ModuleManifest) ToSDK() codersdk.TemplateBuilderModule {
|
||||
Default: v.Default,
|
||||
Required: v.Required,
|
||||
Sensitive: v.Sensitive,
|
||||
Computed: v.Computed,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user