Skip to content

[TFDN-182] TFE ToolVersion API Doc Updates for ARM Support #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

[TFDN-182] TFE ToolVersion API Doc Updates for ARM Support #547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a13fa3f
update all toolversion api docs for arm support
kelsi-hoyle Jul 7, 2025
f61c49e
add step for selecting OS Architecture
kelsi-hoyle Jul 8, 2025
9384b3b
Add details for each arch field
natalie-todd Jul 11, 2025
ce8163a
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
fbb1ca4
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
426f9fd
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
39505dc
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
5b5f5ed
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
307208f
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
be8b95c
Update content/terraform-enterprise/v202506-1/docs/enterprise/api-doc…
natalie-todd Jul 14, 2025
d587190
Remove deprecation verbiage
natalie-todd Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ tfe-releases-repos.json

# copy-cloud-docs-for-tfe action
.github/actions/copy-cloud-docs-for-tfe/node_modules

.idea
191 changes: 152 additions & 39 deletions .../terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/opa-versions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,31 +79,60 @@ curl \
"type": "opa-versions",
"attributes": {
"version": "0.55.0",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_arm64_static",
"sha": "d19603df4ab619e98cc515084f62b839464ee5bff61383d1df7724db8a7027a9",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_amd64_static",
"sha": "388af161328871b943306f1ba7948658810a9fcf9c3c0a27bdfac6e8086617a9",
"deprecated": false,
"deprecated-reason": null,
"official": true,
"enabled": true,
"beta": false,
"usage": 0,
"created-at": "2023-08-23T22:34:24.561Z"
"created-at": "2023-08-23T22:34:24.561Z",
,
"archs": [
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_arm64_static",
"sha": "d19603df4ab619e98cc515084f62b839464ee5bff61383d1df7724db8a7027a9",
"os": "linux",
"arch": "arm64"
},
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_amd64_static",
"sha": "388af161328871b943306f1ba7948658810a9fcf9c3c0a27bdfac6e8086617a9",
"os": "linux",
"arch": "amd64"
}
]
}
},
{
"id": "tool-qcbYn12vuRKPgPpy",
"type": "opa-versions",
"attributes": {
"version": "0.54.0",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"deprecated": false,
"deprecated-reason": null,
"official": true,
"enabled": true,
"beta": false,
"usage": 2,
"created-at": "2023-08-23T22:34:24.561Z"
"created-at": "2023-08-23T22:34:24.561Z",
"archs": [
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"os": "linux",
"arch": "arm64"
},
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"os": "linux",
"arch": "amd64",
}
]
}
}
],
Expand Down Expand Up @@ -142,17 +171,24 @@ This POST endpoint requires a JSON object with the following properties as a req

Properties without a default value are required.

| Key path | Type | Default | Description |
| ----------------------------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------- |
| `data.type` | string | | Must be `"opa-versions"`. |
| `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"`). |
| `data.attributes.url` | string | | The URL where you can download the 64-bit Linux binary of this version. |
| `data.attributes.sha` | string | | The SHA-256 checksum of the OPA binary. |
| `data.attributes.deprecated` | bool | `false` | Whether or not this version of OPA is deprecated. |
| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of OPA is deprecated. Field is null unless deprecated is `true`. |
| `data.attributes.official` | bool | `false` | Whether or not this is an official release of OPA. |
| `data.attributes.enabled` | bool | `true` | Whether or not this version of OPA is enabled for use in HCP Terraform. |
| `data.attributes.beta` | bool | `false` | Whether or not this version of OPA is a beta pre-release. |
We recommend setting the URL and SHA-256 checksum of an OPA binary in the `archs[n].url` and `archs[n].sha` fields.

| Key path | Type | Default | Description |
| ----------------------------------- | ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data.type` | string | | Must be `"opa-versions"`. |
| `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"`). |
| `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. |
| `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 OPA binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
| `data.attributes.deprecated` | bool | `false` | Whether or not this version of OPA is deprecated. |
| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of OPA is deprecated. Field is null unless deprecated is `true`. |
| `data.attributes.official` | bool | `false` | Whether or not this is an official release of OPA. |
| `data.attributes.enabled` | bool | `true` | Whether or not this version of OPA is enabled for use in HCP Terraform. |
| `data.attributes.beta` | bool | `false` | Whether or not this version of OPA is a beta pre-release. |
| `data.attributes.archs` | array | | An array of architecture objects. |
| `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. |
| `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. |
| `data.attributes.archs[n].os` | string |`"linux"`| OPA version operating system. |
| `data.attributes.archs[n].arch` | string |`"amd64"`| OPA version architecture. |

### Sample Payload

Expand All @@ -162,11 +198,23 @@ Properties without a default value are required.
"type": "opa-versions",
"attributes": {
"version": "0.11.8",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"official": true,
"enabled": true,
"beta": false
"beta": false,
"archs": [
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"os": "linux",
"arch": "arm64"
},
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"os": "linux",
"arch": "amd64"
}
]
}
}
}
Expand All @@ -192,15 +240,29 @@ curl \
"type": "opa-versions",
"attributes": {
"version": "0.54.0",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"official": true,
"deprecated": false,
"deprecated-reason": null,
"enabled": true,
"beta": false,
"usage": 0,
"created-at": "2023-08-23T22:34:24.561Z"
"created-at": "2023-08-23T22:34:24.561Z",
"archs": [
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"os": "linux",
"arch": "arm64"
},
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"os": "linux",
"arch": "amd64"
}
]
}
}
}
Expand Down Expand Up @@ -237,15 +299,29 @@ curl \
"type": "opa-versions",
"attributes": {
"version": "0.54.0",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"official": true,
"deprecated": false,
"deprecated-reason": null,
"enabled": true,
"beta": false,
"usage": 0,
"created-at": "2023-08-23T22:34:24.561Z"
"created-at": "2023-08-23T22:34:24.561Z",
"archs": [
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8",
"os": "linux",
"arch": "arm64"
},
{
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3",
"os": "linux",
"arch": "amd64",
}
]
}
}
}
Expand All @@ -271,17 +347,26 @@ This PATCH endpoint requires a JSON object with the following properties as a re

Properties without a default value are required.

| Key path | Type | Default | Description |
| ----------------------------------- | ------ | ---------------- | ----------------------------------------------------------------------------------------------------- |
| `data.type` | string | | Must be `"opa-versions"`. |
| `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"`). |
| `data.attributes.url` | string | (previous value) | The URL where you can download the 64-bit Linux binary of this version. |
| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the OPA binary. |
| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of OPA. |
| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of OPA is deprecated. |
| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of OPA is deprecated. |
| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of OPA is enabled for use in HCP Terraform. |
| `data.attributes.beta` | bool | (previous value) | Whether or not this version of OPA is a beta pre-release. |
We recommend setting the URL and SHA-256 checksum of an OPA binary in the `archs[n].url` and `archs[n].sha` fields.

| Key path | Type | Default | Description |
| ----------------------------------- | ------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data.type` | string | | Must be `"opa-versions"`. |
| `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"`). |
| `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. |
| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 OPA binary. This field is under review. We recommend using the `archs[n].sha` field instead. |
| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of OPA. |
| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of OPA is deprecated. |
| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of OPA is deprecated. |
| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of OPA is enabled for use in HCP Terraform. |
| `data.attributes.beta` | bool | (previous value) | Whether or not this version of OPA is a beta pre-release. |
| `data.attributes.archs` | array | | An array of architecture objects. |
| `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. |
| `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. |
| `data.attributes.archs[n].os` | string |`"linux"`| OPA version operating system. |
| `data.attributes.archs[n].arch` | string |`"amd64"`| OPA version architecture. |



### Sample Payload

Expand All @@ -291,7 +376,21 @@ Properties without a default value are required.
"type": "opa-versions",
"attributes": {
"deprecated": true,
"deprecated-reason": "A bug was discovered in this version of OPA. Please upgrade as soon as possible"
"deprecated-reason": "A bug was discovered in this version of OPA. Please upgrade as soon as possible",
"archs": [
{
"os": "linux",
"arch": "arm64",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8"
},
{
"os": "linux",
"arch": "amd64",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8"
}
]
}
}
}
Expand Down Expand Up @@ -325,7 +424,21 @@ curl \
"enabled": true,
"beta": false,
"usage": 0,
"created-at": "2023-08-23T22:34:24.561Z"
"created-at": "2023-08-23T22:34:24.561Z",
"archs": [
{
"os": "linux",
"arch": "arm64",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8"
},
{
"os": "linux",
"arch": "amd64",
"url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static",
"sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8"
}
]
}
}
}
Expand Down
Loading
Loading