Skip to content
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

Update Explorer API docs with new field billable_rum_count #822

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

Update Explorer API docs with new field billable_rum_count #822

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4125b9c
Update Explorer API docs with new field billable_rum_count
emailnitram Jan 30, 2025
caa986a
remove quotes
emailnitram Jan 30, 2025
0dfbbee
update changelog
emailnitram Jan 30, 2025
0f927d0
Update website/docs/cloud-docs/api-docs/changelog.mdx
emailnitram Feb 24, 2025
ae40f79
Update website/docs/cloud-docs/api-docs/explorer.mdx
emailnitram Feb 24, 2025
a96c306
Update website/docs/cloud-docs/api-docs/explorer.mdx
emailnitram Feb 24, 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
5 changes: 5 additions & 0 deletions website/docs/cloud-docs/api-docs/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ description: >-

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

<!-- BEGIN: TFC:only name:explorer -->
## 2025-01-30
* Add new field `billable_rum_count` to the [explorer](/terraform/cloud-docs/api-docs/explorer) in the `workspaces` view type.
<!-- END: TFC:only name:explorer -->

## 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)
Expand Down
11 changes: 8 additions & 3 deletions website/docs/cloud-docs/api-docs/explorer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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](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. |
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -762,6 +765,7 @@ curl \
{
"attributes": {
"all-checks-succeeded": true,
"billable_rum_count": 0,
"checks-errored": 0,
"checks-failed": 0,
"checks-passed": 0,
Expand Down Expand Up @@ -793,6 +797,7 @@ curl \
{
"attributes": {
"all-checks-succeeded": true,
"billable_rum_count": 0,
"checks-errored": 0,
"checks-failed": 0,
"checks-passed": 0,
Expand Down