Skip to content

Commit cbffefb

Browse files
rkoron007rkoron007
authored
Module revocation missing from v202506-01 (#528)
1 parent 6cac66e commit cbffefb

File tree

3 files changed

+21
-48
lines changed

3 files changed

+21
-48
lines changed

‎content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/changelog.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ source: terraform-docs-common
1111

1212
Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
1313

14+
1415
## 2025-05-1
1516

1617
- Add `agent-pool` relationship to the [run task API](/terraform/enterprise/api-docs/run-tasks/run-tasks), which you can use to assign a run task to an agent pool.
18+
<!-- BEGIN: TFC:only name:premium -->
1719
- Add `private-run-tasks` to [feature entitlements](/terraform/enterprise/api-docs#feature-entitlements).
18-
<!-- BEGIN: TFC:only name:revoke -->
20+
<!-- END: TFC:only name:premium -->
1921
- You can now revoke, and revert the revocation of, module versions. Learn more about [Managing module versions](/terraform/enterprise/api-docs/private-registry/manage-module-versions).
20-
<!-- END: TFC:only name:revoke -->
2122

2223
## 2025-4-17
2324

@@ -34,8 +35,12 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
3435

3536
## 2025-03-10
3637

38+
<!-- BEGIN: TFC:only name:explorer -->
39+
3740
- Add new field `current_rum_count` to the [explorer API](/terraform/enterprise/api-docs/explorer) in the `workspaces` view type that lists a workspace's current resources under management.
3841

42+
<!-- END: TFC:only name:explorer -->
43+
3944
## 2024-11-19
4045

4146
- Clarify `tag-bindings` and `effective-tag-bindings` on [workspaces](/terraform/enterprise/api-docs/workspaces) and [projects](/terraform/enterprise/api-docs/projects)
@@ -272,7 +277,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
272277
- Add the new `enforcement-level` property in the request and response of [Policies endpoints](/terraform/enterprise/api-docs/policies).
273278
- Deprecate the old `enforce` property in the request and response of [Policies endpoints](/terraform/enterprise/api-docs/policies).
274279
<!-- BEGIN: TFC:only -->
275-
- Add new properties to limit run tasks and policies for the Terraform Cloud free tier. We updated the [entitlement set](/terraform/enterprise/api-docs/organizations#show-the-entitlement-set), [feature set](/terraform/enterprise/api-docs/feature-sets#sample-response), and [subscription](/terraform/enterprise/api-docs/subscriptions#sample-response) endpoints with the following properties:
280+
- Add new properties to limit run tasks and policies for the Terraform Cloud free tier. We updated the [entitlement set](/terraform/enterprise/api-docs/organizations#show-the-entitlement-set), [feature set](/terraform/enterprise/api-docs/organizations#show-the-entitlement-set), and [subscription](/terraform/enterprise/api-docs/subscriptions#sample-response) endpoints with the following properties:
276281
- `run-task-limit`
277282
- `run-task-workspace-limit`
278283
- `run-task-mandatory-enforcement-limit`
@@ -399,7 +404,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
399404
### 2022-06-17
400405

401406
- Updated [Creating a Run Task](/terraform/enterprise/workspaces/settings/run-tasks#creating-a-run-task) section to include the new description information for the run task to be configured.
402-
- Update [Run Tasks](/terraform/enterprise/api-docs/run-tasks.mdx) to include the new description attribute.
407+
- Update [Run Tasks](/terraform/enterprise/api-docs/run-tasks) to include the new description attribute.
403408

404409
### 2022-06-09
405410

@@ -416,7 +421,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
416421

417422
### 2022-05-04
418423

419-
- Updated [Feature Sets](/terraform/enterprise/api-docs/feature-sets#list-feature-sets) to add new `run-tasks` attribute.
424+
- Updated [Feature Sets](/terraform/enterprise/api-docs/organizations#show-the-entitlement-set) to add new `run-tasks` attribute.
420425

421426
### 2022-05-03
422427

@@ -464,11 +469,11 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
464469
### 2021-11-17
465470

466471
- Added pagination support to the following endpoints:
467-
- [Feature Sets](/terraform/enterprise/api-docs/feature-sets#list-feature-sets) - `GET /feature-sets`
472+
- [Feature Sets](/terraform/enterprise/api-docs/organizations#show-the-entitlement-set) - `GET /feature-sets`
468473
- [Notification Configurations](/terraform/enterprise/api-docs/notification-configurations#list-notification-configurations) - `GET /workspaces/:workspace_id/notification-configurations`
469474
- [Oauth Clients](/terraform/enterprise/api-docs/oauth-clients#list-oauth-clients) - `GET /organizations/:organization_name/oauth-clients`
470475
- [Oauth Tokens](/terraform/enterprise/api-docs/oauth-tokens#list-oauth-tokens) - `GET /oauth-clients/:oauth_client_id/oauth-tokens`
471-
- [Organization Feature Sets](/terraform/enterprise/api-docs/feature-sets#list-feature-sets-for-organization) - `GET /organizations/:organization_name/feature-sets`
476+
- [Organization Feature Sets](/terraform/enterprise/api-docs#feature-entitlements) - `GET /organizations/:organization_name/feature-sets`
472477
- [Organizations](/terraform/enterprise/api-docs/organizations#list-organizations) - `GET /organizations`
473478
- [Policy Checks](/terraform/enterprise/api-docs/policy-checks#list-policy-checks) - `GET /runs/:run_id/policy-checks`
474479
- [Policy Set Parameters](/terraform/enterprise/api-docs/policy-set-params#list-parameters) - `GET /policy-sets/:policy_set_id/parameters`

‎content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/private-registry/manage-module-versions.mdx

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ source: terraform-docs-common
4242

4343
Use the module version management API endpoints to deprecate, revoke, and revert of status of module versions in your organization’s private registry.
4444

45-
<>{/* TODO: remove revoke references here */}</>
46-
4745
<!-- BEGIN: TFC:only name:pnp-callout -->
4846

4947
@include "tfc-package-callouts/manage-module-versions.mdx"
@@ -52,18 +50,12 @@ Use the module version management API endpoints to deprecate, revoke, and revert
5250

5351
## Overview
5452

55-
<>{/* TODO: remove revoke references here */}</>
56-
5753
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.
5854

5955
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.
6056

61-
<!-- BEGIN: TFC:only name:revoke -->
62-
6357
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.
6458

65-
<!-- END: TFC:only name:revoke -->
66-
6759
For more details on deprecating or revoking module versions, refer to [Manage module versions](/terraform/enterprise/registry/manage-module-versions).
6860

6961
## Deprecate a module version
@@ -83,7 +75,7 @@ This endpoint allows you to deprecate a specific module version. Deprecating a m
8375

8476
| Status | Response | Reason |
8577
| :----------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- |
86-
| [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. |
78+
| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/enterprise/api-docs#json-api-documents) | Successfully deprecated a module version. |
8779
| [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. |
8880
| [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. |
8981
| [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. |
@@ -162,7 +154,7 @@ Deprecating a module version adds warnings to the run output of any consumers us
162154

163155
| Status | Response | Reason |
164156
| :--------------------------------------------------------------------------- | :---------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- |
165-
| [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. |
157+
| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/enterprise/api-docs#json-api-documents) | Successfully reverted a module version’s deprecation status and reinstated that version. |
166158
| [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. |
167159
| [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. |
168160
| [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. |
@@ -283,8 +275,6 @@ The response includes multiple versions, and each version has a `deprecation` ke
283275
}
284276
```
285277

286-
<!-- BEGIN: TFC:only name:revoke -->
287-
288278
## Revoke a module version
289279

290280
Use this endpoint to revoke a module version. You must [deprecate a module version](#deprecate-a-module-version) before you can revoke it.
@@ -302,7 +292,7 @@ This endpoint allows you to revoke a specific module version. Revoking a module
302292

303293
| Status | Response | Reason |
304294
| :----------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- |
305-
| [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. |
295+
| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/enterprise/api-docs#json-api-documents) | Successfully revoked a module version. |
306296
| [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. |
307297
| [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. |
308298
| [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. |
@@ -388,7 +378,7 @@ When you revert the revocation of a module version, HCP Terraform sets that vers
388378

389379
| Status | Response | Reason |
390380
| :--------------------------------------------------------------------------- | :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------- |
391-
| [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. |
381+
| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/enterprise/api-docs#json-api-documents) | Successfully reverted a module version’s revocation status and deprecated that version. |
392382
| [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. |
393383
| [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. |
394384
| [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. |
@@ -527,5 +517,3 @@ The response includes the revoked versions of this module in the `revoked-versio
527517
},
528518
}
529519
```
530-
531-
<!-- END: TFC:only name:revoke -->

0 commit comments

Comments
 (0)