[IPL-7725] Adding Support for Calls to /workspaces/{external_id}/all-vars API Endpoint on HCP Terraform
#1105
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8000
…ed with a workspace including variables that inherited from organization and/or project variable sets. The List API does not include variables that are inherited from varsets but not overwritten in the workspace.
…-vars API and adding integration tests
for /api/v2/workspaces/{id}/all-vars API
for /api/v2/workspaces/{id}/all-vars API
/workspaces/{external_id}/all-vars Endpoint on HCP Terraform
/workspaces/{external_id}/all-vars Endpoint on HCP Terraform/workspaces/{external_id}/all-vars API Endpoint on HCP Terraform
mkam
reviewed
Jun 11, 2025
CHANGELOG.md
Outdated
| @@ -28,6 +28,8 @@ | |||
|
|
|||
| * Add BETA support for use of OPA and Sentinel with Linux arm64 agents, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users @natalie-todd [#1090](https://github.com/hashicorp/go-tfe/pull/1090) | |||
|
|
|||
| * Add support for HCP Terraform `/api/v2/workspaces/{external_id}/all-vars` API endpoint to fetch the list of all variables available to a workspce (include inherited variables from varsets) by @debrin-hc [#1105](https://github.com/hashicorp/go-tfe/pull/1105) | |||
|
|
|||
There was a problem hiding this comment.
This should be moved to the Unreleased version.
mkam
approved these changes
Jun 12, 2025
ctrombley
approved these changes
Jun 12, 2025
|
Reminder to the contributor 95FF that merged this PR: if your changes have added important functionality or fixed a relevant bug, open a follow-up PR to update CHANGELOG.md with a note on your changes. |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the support to make calls to the
/workspaces/{external_id}/all-varsV2 API, which now returns the list of all variables accessible in a workspace. This list now includes all variables inherited from organization and project level variable sets in HCP Terraform. The existing V2 API/workspaces/{external_id}/varsonly returns the list of variables defined in a workspace, and excludes inherited but not overwritten variables from varsets.With this change, the remote / backend context in terraform core can effectively call this API to fetch the list of accessible variables, effectively fixing the bug mentioned in IPL-7725. The bug talks about such inherited but not overwritten variables defined in a terraform configuration, which causes a "No value for required variable" error while doing a
terraform importfrom the CLI.Testing plan
External links
Output from tests
Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.
Rollback Plan
Not required. This adds support for a new V2 API and does not affect any existing workflows.