Skip to content

Commit d69f60c

Browse files
natalie-toddnatalie-todd
committed
Remove deprecation verbiage
1 parent be8b95c commit d69f60c

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

‎content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/opa-versions.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -171,22 +171,22 @@ This POST endpoint requires a JSON object with the following properties as a req
171171

172172
Properties without a default value are required.
173173

174-
~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of an OPA binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums.
174+
We recommend setting the URL and SHA-256 checksum of an OPA binary in the `archs[n].url` and `archs[n].sha` fields.
175175

176176
| Key path | Type | Default | Description |
177177
| ----------------------------------- | ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
178178
| `data.type` | string | | Must be `"opa-versions"`. |
179179
| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). |
180-
| `data.attributes.url` | string | | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. |
181-
| `data.attributes.sha` | string | | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 OPA binary. |
180+
| `data.attributes.url` | string | | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. |
181+
| `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
182182
| `data.attributes.deprecated` | bool | `false` | Whether or not this version of OPA is deprecated. |
183183
| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of OPA is deprecated. Field is null unless deprecated is `true`. |
184184
| `data.attributes.official` | bool | `false` | Whether or not this is an official release of OPA. |
185185
| `data.attributes.enabled` | bool | `true` | Whether or not this version of OPA is enabled for use in HCP Terraform. |
186186
| `data.attributes.beta` | bool | `false` | Whether or not this version of OPA is a beta pre-release. |
187187
| `data.attributes.archs` | array | | An array of architecture objects. |
188-
| `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. |
189-
| `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the OPA binary. |
188+
| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. |
189+
| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the OPA binary. We recommend using this field to set the checksum instead of the `sha` field. |
190190
| `data.attributes.archs[n].os` | string |`"linux"`| OPA version operating system. |
191191
| `data.attributes.archs[n].arch` | string |`"amd64"`| OPA version architecture. |
192192

@@ -347,22 +347,22 @@ This PATCH endpoint requires a JSON object with the following properties as a re
347347

348348
Properties without a default value are required.
349349

350-
~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of an OPA binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums.
350+
We recommend setting the URL and SHA-256 checksum of an OPA binary in the `archs[n].url` and `archs[n].sha` fields.
351351

352352
| Key path | Type | Default | Description |
353353
| ----------------------------------- | ------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
354354
| `data.type` | string | | Must be `"opa-versions"`. |
355355
| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). |
356-
| `data.attributes.url` | string | (previous value) | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. |
357-
| `data.attributes.sha` | string | (previous value) | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 OPA binary. |
356+
| `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. |
357+
| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
358358
| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of OPA. |
359359
| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of OPA is deprecated. |
360360
| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of OPA is deprecated. |
361361
| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of OPA is enabled for use in HCP Terraform. |
362362
| `data.attributes.beta` | bool | (previous value) | Whether or not this version of OPA is a beta pre-release. |
363363
| `data.attributes.archs` | array | | An array of architecture objects. |
364-
| `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. |
365-
| `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the OPA binary. |
364+
| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. |
365+
| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the OPA binary. We recommend using this field to set the checksum instead of the `sha` field. |
366366
| `data.attributes.archs[n].os` | string |`"linux"`| OPA version operating system. |
367367
| `data.attributes.archs[n].arch` | string |`"amd64"`| OPA version architecture. |
368368

‎content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/sentinel-versions.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -144,22 +144,22 @@ This POST endpoint requires a JSON object with the following properties as a req
144144

145145
Properties without a default value are required.
146146

147-
~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Sentinel binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums.
147+
We recommend setting the URL and SHA-256 checksum of a Sentinel binary in the `archs[n].url` and `archs[n].sha` fields.
148148

149149
| Key path | Type | Default | Description |
150150
| ----------------------------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
151151
| `data.type` | string | | Must be `"sentinel-versions"`. |
152152
| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). |
153-
| `data.attributes.url` | string | | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. |
154-
| `data.attributes.sha` | string | | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Sentinel binary. |
153+
| `data.attributes.url` | string | | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. |
154+
| `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
155155
| `data.attributes.deprecated` | bool | `false` | Whether or not this version of Sentinel is deprecated. |
156156
| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of Sentinel is deprecated. Field is null unless deprecated is `true`. |
157157
| `data.attributes.official` | bool | `false` | Whether or not this is an official release of Sentinel. |
158158
| `data.attributes.enabled` | bool | `true` | Whether or not this version of Sentinel is enabled for use in HCP Terraform. |
159159
| `data.attributes.beta` | bool | `false` | Whether or not this version of Sentinel is a beta pre-release. |
160160
| `data.attributes.archs` | array | | An array of architecture objects. |
161-
| `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. |
162-
| `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Sentinel binary. |
161+
| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. |
162+
| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Sentinel binary. We recommend using this field to set the checksum instead of the `sha` field. |
163163
| `data.attributes.archs[n].os` | string |`"linux"`| Sentinel version operating system. |
164164
| `data.attributes.archs[n].arch` | string |`"amd64"`| Sentinel version architecture. |
165165

@@ -326,16 +326,16 @@ We recommend setting the URL and SHA-256 checksum of a Sentinel binary in the `a
326326
| ----------------------------------- | ------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
327327
| `data.type` | string | | Must be `"sentinel-versions"`. |
328328
| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). |
329-
| `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. |
330-
| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
329+
| `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. |
330+
| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
331331
| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of Sentinel. |
332332
| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of Sentinel is deprecated. |
333333
| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Sentinel is deprecated. |
334334
| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Sentinel is enabled for use in HCP Terraform. |
335335
| `data.attributes.beta` | bool | (previous value) | Whether or not this version of Sentinel is a beta pre-release. |
336336
| `data.attributes.archs` | array | | An array of architecture objects. |
337-
| `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. |
338-
| `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Sentinel binary. |
337+
| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. |
338+
| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Sentinel binary. We recommend using this field to set the checksum instead of the `sha` field. |
339339
| `data.attributes.archs[n].os` | string |`"linux"`| Sentinel version operating system. |
340340
| `data.attributes.archs[n].arch` | string |`"amd64"`| Sentinel version architecture. |
341341

0 commit comments

Comments
 (0)