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

Jump to bottom

Update Explorer API docs with new field current_rum_count #822

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

Update Explorer API docs with new field current_rum_count #822

wants to merge 9 commits into from
+13 −3

Conversation

emailnitram
Copy link
Contributor

@emailnitram emailnitram commented Jan 30, 2025 •
edited
Loading

What

A new field has been added to Workspace Explorer in HCP Terraform

Why

This change helps customers see the new field and field type to help when querying data from Explorer. Sample response has also been updated with this new field

Related Jira
Related Atlas PR

Screenshots

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages. (N/A)
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.). (N/A)
  • Pages with related content are updated and link to this content when appropriate. (N/A)
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages. (N/A)
  • New pages have metadata (page name and description) at the top. (N/A)
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility. (N/A)
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars. (N/A)
  • UI elements (button names, page names, etc.) are bolded. (N/A)
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

Sorry, something went wrong.

@vercel Vercel
Copy link

vercel bot commented Jan 30, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 6, 2025 6:44pm

@emailnitram emailnitram added HCP Terraform enhancement New feature or request labels Jan 30, 2025
rkoron007
rkoron007 approved these changes Feb 24, 2025
View reviewed changes
Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few small suggestions, but looks great otherwise!

emailnitram and others added 2 commits February 24, 2025 11:50
@emailnitram @rkoron007
Update website/docs/cloud-docs/api-docs/changelog.mdx
0f927d0 
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
@emailnitram @rkoron007
Update website/docs/cloud-docs/api-docs/explorer.mdx
ae40f79 
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
@emailnitram @rkoron007
Update website/docs/cloud-docs/api-docs/explorer.mdx
a96c306 
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
rkoron007
rkoron007 reviewed Mar 6, 2025
View reviewed changes
Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some questions, thanks for tagging me in and let me know if you have any questions for me!

rkoron007
rkoron007 approved these changes Mar 6, 2025
View reviewed changes
Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

emailnitram and others added 2 commits March 6, 2025 10:30
@emailnitram @rkoron007
Update website/docs/cloud-docs/api-docs/changelog.mdx
3aa41dd 
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
@emailnitram
update date
e21dabb
@emailnitram emailnitram changed the title Update Explorer API docs with new field billable_rum_count Update Explorer API docs with new field current_rum_count Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonxmh simonxmh

@rkoron007 rkoron007

Assignees
No one assigned
Labels
do not merge enhancement New feature or request HCP Terraform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@emailnitram @simonxmh @rkoron007