From 4a9ea43f7f0906690f712ab009000156ae62b499 Mon Sep 17 00:00:00 2001 From: rkoron007 Date: Thu, 5 Jun 2025 16:29:15 -0700 Subject: [PATCH 1/4] Finally get to the changes from last TFE release --- .../docs/cloud-docs/api-docs/changelog.mdx | 7 ++++-- .../docs/cloud-docs/api-docs/index.mdx | 4 +++- .../manage-module-versions.mdx | 12 ---------- .../run-tasks/run-tasks-integration.mdx | 5 ++++ .../api-docs/run-tasks/run-tasks.mdx | 2 +- .../integrations/kubernetes/setup.mdx | 8 +++---- .../docs/cloud-docs/registry/index.mdx | 2 ++ .../registry/manage-module-versions.mdx | 24 +++---------------- .../users-teams-organizations/api-tokens.mdx | 4 ++-- .../docs/cloud-docs/vcs/index.mdx | 4 ++-- 10 files changed, 27 insertions(+), 45 deletions(-) diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx index b7c5cedeca..e35156e31a 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx @@ -11,10 +11,11 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise. ## 2025-05-1 * Add `agent-pool` relationship to the [run task API](/terraform/cloud-docs/api-docs/run-tasks/run-tasks), which you can use to assign a run task to an agent pool. + * Add `private-run-tasks` to [feature entitlements](/terraform/cloud-docs/api-docs#feature-entitlements). - + * You can now revoke, and revert the revocation of, module versions. Learn more about [Managing module versions](/terraform/cloud-docs/api-docs/private-registry/manage-module-versions). - + ## 2025-4-17 * Document inherited-from link associated with effective tag bindings. @@ -25,8 +26,10 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise. ## 2025-3-10 * Document unique pagination metadata given in the response of [Organization Runs Index API](/terraform/cloud-docs/api-docs/run##list-runs-in-an-organization). + ## 2025-03-10 * Add new field `current_rum_count` to the [explorer API](/terraform/cloud-docs/api-docs/explorer) in the `workspaces` view type that lists a workspace's current resources under management. + ## 2024-11-19 diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx index 76ab2c3d70..7a058b2173 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx @@ -94,8 +94,10 @@ The following entitlements are available: - `policy-enforcement` — Allows an organization to use [Sentinel][]. Affects the [policies][], [policy sets][], and [policy checks][] endpoints. - `private-module-registry` — Allows an organization to publish and use modules with the [private module registry][]. Affects the [registry modules][] endpoints. - `private-policy-agents` - Allows an organization to ensure that HTTP enabled [Sentinel][] and OPA [policies][] can communicate with isolated, private, or on-premises infrastructure. + - `private-run-tasks` - Allows an organization to ensure that [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) can communicate with isolated, private, or on-premises infrastructure. - `private-vcs` - Allows a self-hosted HCP Terraform agent to [connect to a private VCS provider](/terraform/cloud-docs/vcs/private) without having to expose that provider to the public internet. + - `run-tasks` — Allows an organization to use [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks). Affects the [run tasks][] endpoints. - `self-serve-billing` — Allows an organization to pay via credit card using the in-app billing UI. - `sentinel` - **DEPRECATED** Use `policy-enforcement` instead. @@ -337,7 +339,7 @@ $ curl \ ## Rate Limiting -You can make up to 30 requests per second to most API endpoints as an authenticated or unauthenticated request. If you reach the rate limit then your access will be throttled and an error response will be returned. +You can make up to 30 requests per second to most API endpoints as an authenticated or unauthenticated request. If you reach the rate limit then your access will be throttled and an error response will be returned. Requests are per user, not per token. As a result, you cannot use multiple tokens to make more than 30 requests per second. diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx index 43599011d6..ae6d966568 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx @@ -40,26 +40,18 @@ description: |- Use the module version management API endpoints to deprecate, revoke, and revert of status of module versions in your organization’s private registry. -<>{/* TODO: remove revoke references here */} - @include "tfc-package-callouts/manage-module-versions.mdx" ## Overview -<>{/* TODO: remove revoke references here */} - As part of the module lifecycle, you can deprecate or revoke older module versions as you stop supporting them, signaling to module consumers that they need to upgrade to newer versions. When you deprecate a module version, HCP Terraform adds warnings to the module's registry page and to run outputs when anyone uses the deprecated version. After deprecating a module version, you can revert that deprecated status to remove the warnings from that version in the registry and outputs. - - Revoking a module version adds warnings to the module's registry page, warnings in the run outputs of existing users, and blocks new users from using that version. Reverting a module version’s revocation sets the module version back to a deprecated state. - - For more details on deprecating or revoking module versions, refer to [Manage module versions](/terraform/cloud-docs/registry/manage-module-versions). ## Deprecate a module version @@ -281,8 +273,6 @@ The response includes multiple versions, and each version has a `deprecation` ke } ``` - - ## Revoke a module version Use this endpoint to revoke a module version. You must [deprecate a module version](#deprecate-a-module-version) before you can revoke it. @@ -525,5 +515,3 @@ The response includes the revoked versions of this module in the `revoked-versio }, } ``` - - diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx index 5ea534a2a7..0e1aa877a8 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx @@ -27,7 +27,12 @@ Refer to [run tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) for the When a run reaches the appropriate phase and a run task is triggered, HCP Terraform will send a request to the run task's URL. + + Either HCP Terraform itself, or a self-hosted HCP Terraform agent using [request forwarding](/terraform/cloud-docs/agents/request-forwarding) can make the request to a run task's URL. Your organization [must be entitled to `private-run-tasks`](/terraform/cloud-docs/api-docs#feature-entitlements) to use request forwarding. + + + The service receiving the run task request should respond with `200 OK`, or HCP Terraform will retry to trigger the run task. `POST :url` diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx index f27517d0be..7978fe4bfb 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx @@ -88,7 +88,7 @@ Properties without a default value are required unless otherwise specified. | `data.attributes.global-configuration.enabled` | bool | false | (Optional) Whether the task will be associated on all workspaces. | | `data.attributes.global-configuration.stages` | array | | (Optional) An array of strings representing the stages of the run lifecycle when the run task should begin. Must be one or more of `"pre_plan"`, `"post_plan"`, `"pre_apply"`, or `"post_apply"`. | | `data.attributes.global-configuration.enforcement-level` | string | | (Optional) The enforcement level of the workspace task. Must be `"advisory"` or `"mandatory"`. | -| `data.relationships.agent-pool.data.id` | string | | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements) and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). | +| `data.relationships.agent-pool.data.id` | string | | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires HCP Terraform **Premium** plan, the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements), and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). | ### Sample Payload diff --git a/content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx b/content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx index 319c34b74e..3fc1034947 100644 --- a/content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx @@ -6,13 +6,13 @@ description: >- # Set up the HCP Terraform Operator for Kubernetes -The HCP Terraform Operator for Kubernetes' CustomResourceDefinitions (CRD) allow you to dynamically create HCP Terraform workspaces with Terraform modules, populate workspace variables, and provision infrastructure with Terraform runs. +The HCP Terraform Operator for Kubernetes' CustomResourceDefinitions (CRD) allow you to dynamically create HCP Terraform workspaces with Terraform modules, populate workspace variables, and provision infrastructure with Terraform runs. You can install the operator with the official [HashiCorp Helm chart](https://github.com/hashicorp/hcp-terraform-operator). ## Prerequisites -All HCP Terraform users can use the HCP Terraform Operator for Kubernetes. You can use the operator to manage the supported features that your organization's pricing tier enables. +All HCP Terraform users can use the HCP Terraform Operator for Kubernetes. You can use the operator to manage the supported features that your organization's pricing tier enables. ## Networking requirements @@ -72,7 +72,7 @@ The HCP Terraform Operator for Kubernetes supports the following versions: ```shell-session $ helm install --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator - ``` + ``` When deploying in self-managed Terraform Enterprise, you must set the `operator.tfeAddress` to the specific hostname of the Terraform Enterprise instance: ```shell-session @@ -99,6 +99,6 @@ The HCP Terraform Operator for Kubernetes supports the following versions: When a new version of the HCP Terraform Operator for Kubernetes Helm Chart is available from the HashiCorp Helm repository, you can upgrade with the following command. -``` +```shell-session helm upgrade --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator ``` diff --git a/content/terraform-docs-common/docs/cloud-docs/registry/index.mdx b/content/terraform-docs-common/docs/cloud-docs/registry/index.mdx index 7f023b695b..412ec31c3f 100644 --- a/content/terraform-docs-common/docs/cloud-docs/registry/index.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/registry/index.mdx @@ -13,7 +13,9 @@ HCP Terraform's private registry works similarly to the [public Terraform Regist [Public modules and providers](/terraform/cloud-docs/registry/add) are hosted on the public Terraform Registry and HCP Terraform can automatically synchronize them to an organization's private registry. This lets you clearly designate which public providers and modules are recommended for the organization and makes their supporting documentation and examples centrally accessible. + For more information about publishing artifacts to the public registry with an HCP Terraform organization, refer to [Namespaces](/terraform/cloud-docs/public-namespace). + -> **Note:** Your Terraform Enterprise instance must allow access to `registry.terraform.io`, `https://yy0ffni7mf-dsn.algolia.net/` and `github.com`. diff --git a/content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx b/content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx index 499fc53784..823684af8e 100644 --- a/content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx @@ -6,8 +6,6 @@ description: >- # Manage module versions -<>{/* TODO: remove revoke references here */} - You can manage the lifecycle of module versions in your organization’s private registry by deprecating or revoking module versions as you stop maintaining and supporting those versions. @@ -16,27 +14,20 @@ You can manage the lifecycle of module versions in your organization’s private Deprecating a module version adds warnings to the module's registry page and warnings in the run outputs of any users of that version. - Revoking a module version adds warnings to the module's registry page, warnings in the run outputs of existing users, and prevents new users from consuming that version. - You can also [deprecate or revoke module versions using the HCP Terraform API](/terraform/cloud-docs/api-docs/private-registry/manage-module-versions). -<>{/* TODO: remove revoke references here */} - ## Overview Deprecating a private module version enables platform teams and module authors to signal to consumers that a version is still maintained and supported but is not recommended. HCP Terraform urges existing and new users of deprecated versions to upgrade that version in their configuration. The private registry also denotes which module versions are deprecated, alerting new consumers to use a non-deprecated version. You can revert a module version’s deprecation if you decide to continue supporting that version. Reverting a version’s deprecation removes all warnings from that version in both the module’s registry page and the run outputs of that version’s consumers. - - You can revoke a private module to mark that you not longer support it. Revoking a module version adds similar warnings to deprecation in a module's registry page and the run outputs of current consumers. Revoking a module version also blocks the runs of any new users attempting to add that version to their configuration. Reverting a module version’s revocation sets it back to a deprecated state, signaling that the version is still maintained and supported but not recommended. - ## Requirements @@ -47,14 +38,12 @@ To deprecate a module version or to revert a version’s deprecation: - you must be a member of an organization on the HCP Terraform **Plus** edition - To revoke or to revert a module version’s status: - you must have permission to manage [private registry modules](/terraform/cloud-docs/users-teams-organizations/permissions#manage-private-registry) - the module must be in an organization's [private registry](/terraform/cloud-docs/registry/publish-modules) + - you must be a member of an organization on the HCP Terraform **Premium** edition - - -<>{/* TODO: don't forget to exclude PNP above when remove tags */} + ## Deprecate a module version @@ -112,15 +101,11 @@ To revert a module version’s deprecation, perform the following steps: Reverting the deprecation of a module version removes all warnings from that version in both the module’s registry page and in the run outputs of that module version’s consumers. -<>{/* TODO: add TFE to bullet points */} - - - ## Revoke a module version To revoke a module version, perform the following steps: -1. Sign in to [HCP Terraform](https://app.terraform.io/) and navigate to your organization. +1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to your organization. 1. Choose **Registry** in the sidebar, then select the module version you want to revoke. 1. If you have not already, [deprecate the module version](#deprecate-a-module-version) you want to revoke. 1. Open the **Manage module for organization** dropdown. @@ -164,7 +149,6 @@ Version X.X.X of - If a new user attempts to add a revoked module version to their configuration, their runs fail. If you provided a reason for a module version’s revocation, HCP Terraform displays that reason to users in run outputs: @@ -206,5 +190,3 @@ To revert a module version’s revocation, perform the following steps: 1. Open the **Manage module for organization** dropdown. 1. Select **Revert module version revocation X.X.X**. 1. Click **Revert**. - - diff --git a/content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx b/content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx index 1066584e6f..1c50dd25e5 100644 --- a/content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx @@ -24,9 +24,9 @@ Navigate to the **Organization Settings > API Tokens > Team Tokens** tab to mana Teams can have multiple valid tokens at a time, so long as the tokens' descriptions are unique within the context of the given team. A token without a description is considered a legacy token, and only one legacy token can exist at a given time. -The [**legacy API**](/terraform/cloud-docs/api-docs/team-tokens#legacy-team-tokens-api-reference) will only operate on the legacy token, and generating a new legacy token invalidates the previous legacy token. +The [legacy API](/terraform/cloud-docs/api-docs/team-tokens#legacy-team-tokens-api-reference) uses a legacy token, generating a new legacy token invalidates the previous token. -The [**non-legacy API**](/terraform/cloud-docs/api-docs/team-tokens#team-tokens-api-reference) will support the existence of multiple, valid team tokens, meaning that when a new, non-legacy token is generated, existing tokens will remain valid. +The [current team token API](/terraform/cloud-docs/api-docs/team-tokens#team-tokens-api-reference) supports multiple team tokens, and adding new tokens does not invalidate older ones. Owners and users with [manage teams](/terraform/cloud-docs/users-teams-organizations/permissions#manage-teams) permissions have the ability to enable and disable team token management for a team, which limits the actions that team members can take on a team token. Refer to [Allow Member Token Management](/terraform/cloud-docs/users-teams-organizations/permissions#allow-member-token-management) for more information. diff --git a/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx b/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx index 331bd48278..ada75854e3 100644 --- a/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx @@ -117,13 +117,13 @@ You can use self-hosted HCP Terraform Agents to connect HCP Terraform to your pr ## Configure a VCS host for Terraform Enterprise -You can configure Terraform Enterprise to be accessible over a primary and a secondary hostname so that you can federate workloads associated with your VCS. Refer to [Specify integration setttings](/terraform/enterprise/deploy/configuration/network#specify-integration-settings) for additional information. +You can configure Terraform Enterprise to be accessible over a primary and a secondary hostname so that you can federate workloads associated with your VCS. Refer to [Specify integration setttings](/terraform/enterprise/deploy/configuration/network#specify-integration-settings) for additional information. You must set up new VCS connections any time you update the VCS host configuration. When the VCS integration uses the secondary hostname, you should continue using it while setting up the new VCS connection. When setup is complete, you can use the primary hostname for all other activities. Refer to [`TFE_VCS_HOSTNAME_CHOICE` ](/terraform/enterprise/deploy/reference/configuration#tfe_vcs_hostname_choice) in the configuration reference for additional information. ## Viewing events --> **Note**: The VCS Events page is still in beta as support is being added for additional VCS providers. Currently only GitLab.com connections established after December 2020 are supported. +-> **Note**: The VCS events page is in beta, and only supports GitLab.com connections made after December 2020. VCS events describe changes within your organization for VCS-related actions. The VCS events page only displays events from previously processed commits in the past 30 days. The VCS page indicates previously processed commits with the message, `"Processing skipped for duplicate commit SHA"`. From d9e55d996103b146d6c6f625c7b897909908b1ec Mon Sep 17 00:00:00 2001 From: Rose M Koron <32436232+rkoron007@users.noreply.github.com> Date: Fri, 6 Jun 2025 09:18:33 -0700 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- .../docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx | 2 +- content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx index 7978fe4bfb..a858053244 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx @@ -88,7 +88,7 @@ Properties without a default value are required unless otherwise specified. | `data.attributes.global-configuration.enabled` | bool | false | (Optional) Whether the task will be associated on all workspaces. | | `data.attributes.global-configuration.stages` | array | | (Optional) An array of strings representing the stages of the run lifecycle when the run task should begin. Must be one or more of `"pre_plan"`, `"post_plan"`, `"pre_apply"`, or `"post_apply"`. | | `data.attributes.global-configuration.enforcement-level` | string | | (Optional) The enforcement level of the workspace task. Must be `"advisory"` or `"mandatory"`. | -| `data.relationships.agent-pool.data.id` | string | | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires HCP Terraform **Premium** plan, the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements), and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). | +| `data.relationships.agent-pool.data.id` | string | | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires [HCP Terraform Premium plan](https://www.hashicorp.com/en/pricing?tab=terraform), the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements), and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). | ### Sample Payload diff --git a/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx b/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx index ada75854e3..40618b14a0 100644 --- a/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx @@ -123,7 +123,11 @@ You must set up new VCS connections any time you update the VCS host configurati ## Viewing events --> **Note**: The VCS events page is in beta, and only supports GitLab.com connections made after December 2020. + + +The VCS events page is in beta, and only supports GitLab.com connections made after December 2020. + + VCS events describe changes within your organization for VCS-related actions. The VCS events page only displays events from previously processed commits in the past 30 days. The VCS page indicates previously processed commits with the message, `"Processing skipped for duplicate commit SHA"`. From f6737aa40e71fa5fad2daecb06250d3684d7f824 Mon Sep 17 00:00:00 2001 From: rkoron007 Date: Fri, 6 Jun 2025 09:32:09 -0700 Subject: [PATCH 3/4] fix the broken links --- .../docs/cloud-docs/api-docs/changelog.mdx | 8 ++++---- .../api-docs/private-registry/manage-module-versions.mdx | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx index e35156e31a..94fe01251f 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx @@ -20,7 +20,7 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise. * Document inherited-from link associated with effective tag bindings. ## 2025-03-20 -* Add API documentation for multiple [team tokens](/terraform/cloud-docs/api-docs/api-tokens), and update documentation around [legacy team tokens](/terraform/cloud-docs/api-docs/team-tokens##legacy-team-tokens-api-reference). +* Add API documentation for multiple [team tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens#team-api-tokens), and update documentation around [legacy team tokens](/terraform/cloud-docs/api-docs/team-tokens##legacy-team-tokens-api-reference). * Update existing API documentation for [team tokens](/terraform/cloud-docs/api-docs/team-tokens) to distinguish multiple team tokens from [legacy team tokens](/terraform/cloud-docs/api-docs/team-tokens##legacy-team-tokens-api-reference). ## 2025-3-10 @@ -233,7 +233,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter ## 2023-04-25 -* Add the `version-id` property to the response for the Create, List, and Update [Workspace Variables endpoints](/terraform/cloud-docs/api-docs/workspaces-variables). +* Add the `version-id` property to the response for the Create, List, and Update [Workspace Variables endpoints](terraform/cloud-docs/api-docs/variables). ## 2023-03-30 @@ -321,12 +321,12 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter ### 2022-07-26 * Updated the [Run status list](/terraform/cloud-docs/api-docs/run#run-states) with `fetching`, `queuing`, `pre_plan_running` and `pre_plan_completed` -* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks.mdx) to include the new `stages` attribute when attaching or updating workspace tasks. +* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) to include the new `stages` attribute when attaching or updating workspace tasks. * Updated [Run Tasks Integration](/terraform/cloud-docs/api-docs/run-tasks/run-tasks-integration) to specify the different request payloads for different stages. ### 2022-06-23 -* Added the [Assessments](/terraform/cloud-docs/api-docs/assessments). +* Added the [Assessments](/terraform/cloud-docs/api-docs/assessment-results). * Updated [Workspace](/terraform/cloud-docs/api-docs/workspaces#create-a-workspace) and [Notification Configurations](/terraform/cloud-docs/api-docs/notification-configurations#notification-triggers) to account for assessments. diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx index ae6d966568..8a7f42fb61 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx @@ -72,7 +72,7 @@ This endpoint allows you to deprecate a specific module version. Deprecating a m | Status | Response | Reason | | :---- | :---- | :---- | -| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http://terraform/cloud-docs/api-docs#json-api-documents) | Successfully deprecated a module version. | +| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents) | Successfully deprecated a module version. | | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to deprecate this module version, or the module version does not exist. | | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. | | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while deprecating a module version. | @@ -152,7 +152,7 @@ Deprecating a module version adds warnings to the run output of any consumers us | Status | Response | Reason | | :---- | :---- | :---- | -| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http:///terraform/cloud-docs/api-docs#json-api-documents) | Successfully reverted a module version’s deprecation status and reinstated that version. | +| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents) | Successfully reverted a module version’s deprecation status and reinstated that version. | | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to revert the depreciation of this module version, or the module version does not exist. | | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. | | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503] | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while reverting the deprecation of a module version. | @@ -290,7 +290,7 @@ This endpoint allows you to revoke a specific module version. Revoking a module | Status | Response | Reason | | :---- | :---- | :---- | -| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http://terraform/cloud-docs/api-docs#json-api-documents) | Successfully revoked a module version. | +| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents) | Successfully revoked a module version. | | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to revoke this module version, or the module version does not exist. | | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. | | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while revoking a module version. | @@ -376,7 +376,7 @@ When you revert the revocation of a module version, HCP Terraform sets that vers | Status | Response | Reason | | :---- | :---- | :---- | -| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http:///terraform/cloud-docs/api-docs#json-api-documents) | Successfully reverted a module version’s revocation status and deprecated that version. | +| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents) | Successfully reverted a module version’s revocation status and deprecated that version. | | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to revert the revocation of this module version, or the module version does not exist. | | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. | | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503] | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while reverting the revocation of a module version. | From 5dcec6a002c6ee51f758d4756aa1df53f80669c6 Mon Sep 17 00:00:00 2001 From: rkoron007 Date: Fri, 6 Jun 2025 12:14:12 -0700 Subject: [PATCH 4/4] Fix the final broken link --- .../docs/cloud-docs/api-docs/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx index 94fe01251f..c5c71056c4 100644 --- a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx +++ b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx @@ -343,7 +343,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter ### 2022-06-17 * Updated [Creating a Run Task](/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task) section to include the new description information for the run task to be configured. -* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks.mdx) to include the new description attribute. +* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) to include the new description attribute. ### 2022-06-09