From 4125b9cd2ce7f26061f81948c0ba25065b36c340 Mon Sep 17 00:00:00 2001 From: Martin Henry Date: Thu, 30 Jan 2025 11:48:37 -0800 Subject: [PATCH 1/6] Update Explorer API docs with new field billable_rum_count --- website/docs/cloud-docs/api-docs/explorer.mdx | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/website/docs/cloud-docs/api-docs/explorer.mdx b/website/docs/cloud-docs/api-docs/explorer.mdx index 08bcc56bf..85469a491 100644 --- a/website/docs/cloud-docs/api-docs/explorer.mdx +++ b/website/docs/cloud-docs/api-docs/explorer.mdx @@ -103,6 +103,7 @@ fields available for each view type are detailed below: | Field | Type | Description | | --------------------------------- | ---------- | ----------------------------------------------------------------------------- | | `all_checks_succeeded` | `boolean` | True if checks have succeeded for the workspace, false otherwise. | +| `billable_rum_count` | `number` | The number of "Resources Under Management (RUM)". | | `checks_errored` | `number` | The number of checks that errored without completing. | | `checks_failed` | `number` | The number of checks that completed and failed. | | `checks_passed` | `number` | The number of checks that completed and passed. | @@ -328,6 +329,7 @@ _Show data for all workspaces_ { "attributes": { "all-checks-succeeded": true, + "billable_rum_count": 0, "checks-errored": 0, "checks-failed": 0, "checks-passed": 0, @@ -359,6 +361,7 @@ _Show data for all workspaces_ { "attributes": { "all-checks-succeeded": true, + "billable_rum_count": 0, "checks-errored": 0, "checks-failed": 0, "checks-passed": 0, @@ -454,9 +457,9 @@ curl \ _Show data for all workspaces_ ```csv -all_checks_succeeded,checks_errored,checks_failed,checks_passed,checks_unknown,current_run_applied_at,current_run_external_id,current_run_status,drifted,external_id,module_count,modules,organization_name,project_external_id,project_name,provider_count,providers,resources_drifted,resources_undrifted,state_version_terraform_version,vcs_repo_identifier,workspace_created_at,workspace_name,workspace_terraform_version,workspace_updated_at -"true","0","0","0","0","","run-rdoEKh2Gy3K6SbCZ","planned_and_finished","false","ws-j2sAeWRxou1b5HYf","0","","acme-corp","prj-V61QLE8tvs4NvVZG","Default Project","0","","0","0","1.5.7","","2023-10-17T21:56:45+00:00","payments-service","1.5.7","2023-12-13T15:48:16+00:00" -"true","0","0","0","0","2023-08-18T16:24:59+00:00","run-9MmJaoQTvDCh5wUa","applied","true","ws-igUVNQSYVXRkhYuo","0","","acme-corp","prj-uU2xNqGeG86U9WgT","web","0","","3","3","1.4.5","acmecorp/api","2023-04-25T17:09:14+00:00","api-service","1.4.5","2023-12-13T15:29:03+00:00" +all_checks_succeeded,billable_rum_count,checks_errored,checks_failed,checks_passed,checks_unknown,current_run_applied_at,current_run_external_id,current_run_status,drifted,external_id,module_count,modules,organization_name,project_external_id,project_name,provider_count,providers,resources_drifted,resources_undrifted,state_version_terraform_version,vcs_repo_identifier,workspace_created_at,workspace_name,workspace_terraform_version,workspace_updated_at +"true","0","0","0","0","0","","run-rdoEKh2Gy3K6SbCZ","planned_and_finished","false","ws-j2sAeWRxou1b5HYf","0","","acme-corp","prj-V61QLE8tvs4NvVZG","Default Project","0","","0","0","1.5.7","","2023-10-17T21:56:45+00:00","payments-service","1.5.7","2023-12-13T15:48:16+00:00" +"true","0","0","0","0","0","2023-08-18T16:24:59+00:00","run-9MmJaoQTvDCh5wUa","applied","true","ws-igUVNQSYVXRkhYuo","0","","acme-corp","prj-uU2xNqGeG86U9WgT","web","0","","3","3","1.4.5","acmecorp/api","2023-04-25T17:09:14+00:00","api-service","1.4.5","2023-12-13T15:29:03+00:00" ``` ## List saved views @@ -762,6 +765,7 @@ curl \ { "attributes": { "all-checks-succeeded": true, + "billable_rum_count": 0, "checks-errored": 0, "checks-failed": 0, "checks-passed": 0, @@ -793,6 +797,7 @@ curl \ { "attributes": { "all-checks-succeeded": true, + "billable_rum_count": 0, "checks-errored": 0, "checks-failed": 0, "checks-passed": 0, From caa986a7507d6b4088682e27212f65cd633d6fd0 Mon Sep 17 00:00:00 2001 From: Martin Henry Date: Thu, 30 Jan 2025 11:53:16 -0800 Subject: [PATCH 2/6] remove quotes --- website/docs/cloud-docs/api-docs/explorer.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cloud-docs/api-docs/explorer.mdx b/website/docs/cloud-docs/api-docs/explorer.mdx index 85469a491..acde4d067 100644 --- a/website/docs/cloud-docs/api-docs/explorer.mdx +++ b/website/docs/cloud-docs/api-docs/explorer.mdx @@ -103,7 +103,7 @@ fields available for each view type are detailed below: | Field | Type | Description | | --------------------------------- | ---------- | ----------------------------------------------------------------------------- | | `all_checks_succeeded` | `boolean` | True if checks have succeeded for the workspace, false otherwise. | -| `billable_rum_count` | `number` | The number of "Resources Under Management (RUM)". | +| `billable_rum_count` | `number` | The number of Resources Under Management (RUM). | | `checks_errored` | `number` | The number of checks that errored without completing. | | `checks_failed` | `number` | The number of checks that completed and failed. | | `checks_passed` | `number` | The number of checks that completed and passed. | From 0dfbbeef533efec9a5e5b4342e067b9a337ecee5 Mon Sep 17 00:00:00 2001 From: Martin Henry Date: Thu, 30 Jan 2025 12:01:24 -0800 Subject: [PATCH 3/6] update changelog --- website/docs/cloud-docs/api-docs/changelog.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/docs/cloud-docs/api-docs/changelog.mdx b/website/docs/cloud-docs/api-docs/changelog.mdx index 887690e73..6ba4175e5 100644 --- a/website/docs/cloud-docs/api-docs/changelog.mdx +++ b/website/docs/cloud-docs/api-docs/changelog.mdx @@ -9,6 +9,11 @@ description: >- Keep track of changes to the API for HCP Terraform and Terraform Enterprise. + +## 2025-01-30 +* Add new field `billable_rum_count` to [Explorer](/terraform/cloud-docs/api-docs/explorer) View Type: `workspaces` + + ## 2024-11-19 * Clarifies listing tag-bindings and effective-tag-bindings on [Workspaces](/terraform/cloud-docs/api-docs/workspaces) and [Projects](/terraform/cloud-docs/api-docs/projects) * Adds new documentation for PATCHing tag bindings on [Projects](/terraform/cloud-docs/api-docs/projects)/[Workspaces](/terraform/cloud-docs/api-docs/workspaces) From 0f927d04a1dd574bcd7eee8d2ba19bd306647b46 Mon Sep 17 00:00:00 2001 From: Martin Henry Date: Mon, 24 Feb 2025 11:50:19 -0800 Subject: [PATCH 4/6] Update website/docs/cloud-docs/api-docs/changelog.mdx Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com> --- website/docs/cloud-docs/api-docs/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cloud-docs/api-docs/changelog.mdx b/website/docs/cloud-docs/api-docs/changelog.mdx index 6ba4175e5..2e5fc0b95 100644 --- a/website/docs/cloud-docs/api-docs/changelog.mdx +++ b/website/docs/cloud-docs/api-docs/changelog.mdx @@ -11,7 +11,7 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise. ## 2025-01-30 -* Add new field `billable_rum_count` to [Explorer](/terraform/cloud-docs/api-docs/explorer) View Type: `workspaces` +* Add new field `billable_rum_count` to the [explorer](/terraform/cloud-docs/api-docs/explorer) in the `workspaces` view type. ## 2024-11-19 From ae40f79f8073844afcaf7733a08da369397ffb76 Mon Sep 17 00:00:00 2001 From: Martin Henry Date: Mon, 24 Feb 2025 11:50:26 -0800 Subject: [PATCH 5/6] Update website/docs/cloud-docs/api-docs/explorer.mdx Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com> --- website/docs/cloud-docs/api-docs/explorer.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cloud-docs/api-docs/explorer.mdx b/website/docs/cloud-docs/api-docs/explorer.mdx index acde4d067..3d3748da5 100644 --- a/website/docs/cloud-docs/api-docs/explorer.mdx +++ b/website/docs/cloud-docs/api-docs/explorer.mdx @@ -103,7 +103,7 @@ fields available for each view type are detailed below: | Field | Type | Description | | --------------------------------- | ---------- | ----------------------------------------------------------------------------- | | `all_checks_succeeded` | `boolean` | True if checks have succeeded for the workspace, false otherwise. | -| `billable_rum_count` | `number` | The number of Resources Under Management (RUM). | +| `billable_rum_count` | `number` | The number of [resources under management](terraform/cloud-docs/overview/estimate-hcp-terraform-cost#what-is-a-managed-resource) (RUM). | | `checks_errored` | `number` | The number of checks that errored without completing. | | `checks_failed` | `number` | The number of checks that completed and failed. | | `checks_passed` | `number` | The number of checks that completed and passed. | From a96c30681f6cda5554bf342fba10a37873289e59 Mon Sep 17 00:00:00 2001 From: Martin Henry Date: Mon, 24 Feb 2025 11:56:56 -0800 Subject: [PATCH 6/6] Update website/docs/cloud-docs/api-docs/explorer.mdx Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com> --- website/docs/cloud-docs/api-docs/explorer.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cloud-docs/api-docs/explorer.mdx b/website/docs/cloud-docs/api-docs/explorer.mdx index 3d3748da5..fbdd036d7 100644 --- a/website/docs/cloud-docs/api-docs/explorer.mdx +++ b/website/docs/cloud-docs/api-docs/explorer.mdx @@ -103,7 +103,7 @@ fields available for each view type are detailed below: | Field | Type | Description | | --------------------------------- | ---------- | ----------------------------------------------------------------------------- | | `all_checks_succeeded` | `boolean` | True if checks have succeeded for the workspace, false otherwise. | -| `billable_rum_count` | `number` | The number of [resources under management](terraform/cloud-docs/overview/estimate-hcp-terraform-cost#what-is-a-managed-resource) (RUM). | +| `billable_rum_count` | `number` | The number of [resources under management](/terraform/cloud-docs/overview/estimate-hcp-terraform-cost#what-is-a-managed-resource) (RUM). | | `checks_errored` | `number` | The number of checks that errored without completing. | | `checks_failed` | `number` | The number of checks that completed and failed. | | `checks_passed` | `number` | The number of checks that completed and passed. |