@@ -38,13 +38,18 @@ tfc_only: true
38
38
[ JSON API error object ] : https://jsonapi.org/format/#error-objects
39
39
40
40
# Manage module versions API
41
- Deprecating a module version in your organization’s private registry adds warnings to the module's registry page and warnings in the run outputs of any users of that version.
41
+
42
+ This topic provides reference information about API endpoints that let your deprecate module versions in your organization’s private registry.
43
+
44
+ ## Introduction
45
+
46
+ 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.
42
47
43
48
<!-- BEGIN: TFC :only name :pnp-callout -->
44
49
@include " tfc-package-callouts/manage-module-versions.mdx"
45
50
<!-- END: TFC :only name :pnp-callout -->
46
51
47
- Once you have deprecated a module version, you can revert its deprecation to remove the warnings from that version. For more details on module deprecation, refer to [Deprecate module versions](/terraform/cloud-docs/registry/manage-module-versions).
52
+ After deprecating a module version, you can revert that deprecated status to remove the warnings from that version in the registry and outputs . For more details on module deprecation, refer to [Deprecate module versions](/terraform/cloud-docs/registry/manage-module-versions).
48
53
49
54
@include " public-beta/manage-module-versions.mdx"
50
55
@@ -67,7 +72,7 @@ This endpoint allows you to deprecate a specific module version. Deprecating a m
67
72
68
73
| Status | Response | Reason |
69
74
| :---- | :---- | :---- |
70
- | [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. |
75
+ | [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. |
71
76
| [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. |
72
77
| [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. |
73
78
| [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. |
@@ -130,7 +135,7 @@ https://app.terraform.io/api/v2/organizations/hashicorp/registry-modules/private
130
135
```
131
136
132
137
133
- ## Revert the deprecation of a module version
138
+ ## Revert the deprecation status for a module version
134
139
135
140
Use this endpoint to revert the deprecation of a module version.
136
141
@@ -143,12 +148,11 @@ Use this endpoint to revert the deprecation of a module version.
143
148
| `:module_provider` | Specifies the Terraform provider that this module is used for. |
144
149
| `:module_version` | The module version you want to revert the deprecation of. |
145
150
146
- This endpoint allows you to revert the deprecation of a specific module version. Deprecating a module version adds warnings to the run output of any consumers using this module. Reverting the deprecation removes warnings from the output of consumers and fully reinstates the module version.
147
-
151
+ Deprecating a module version adds warnings to the run output of any consumers using this module. Reverting the deprecation status removes warnings from the output of consumers and fully reinstates the module version.
148
152
149
153
| Status | Response | Reason |
150
154
| :---- | :---- | :---- |
151
- | [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. |
155
+ | [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 . |
152
156
| [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. |
153
157
| [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. |
154
158
| [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. |
0 commit comments