3 - Add API docs for stack deployments and stack deployment groups

[mrinalirao]

What

Note: The following Stacks PRs need to be approved first and in the following order:

1. 1 - Add docs for basic stacks CRUD APIs #898
2. 2 - Add api docs for stack configuration apis #904

This PR adds API docs for basic stacks configuration APIs.
https://hashicorp.atlassian.net/browse/TF-26279

NOTE: This PR will remain in draft as this cannot be merged before stacks goes GA.
The API documentation has been divided into multiple PRs to simplify the review process. As each of these PRs is approved, it will be merged into mr/stacks-api-ga branch.

API's introduced in this PR:

1. GET /stacks/{stack_id}/stack-deployments
2. GET /stacks/{stack_id}/stack-deployments/{stack_deployment_name}
3. GET /stack-configurations/{stack_configuration_id}/stack-deployment-groups
4. GET /stack-configurations/{stack_configuration_id}/stack-deployment-groups/{stack_deployment_group_name}
5. GET /stack-deployment-groups/{stack_deployment_group_id}
6. POST /stack-deployment-groups/{stack_deployment_group_id}/approve-all-plans
7. POST /stack-deployment-groups/{stack_deployment_group_id}/plan
8. POST /stack-deployment-groups/{stack_deployment_group_id}/rerun

Why

In preparation for stacks going GA, we need to document all the public facing API's for stacks

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.
• API documentation and the API Changelog have been updated.
• Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
• Pages with related content are updated and link to this content when appropriate.
• Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
• New pages have metadata (page name and description) at the top.
• 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.
• New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
• UI elements (button names, page names, etc.) are bolded.
• 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.

[vercel]

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	Jun 3, 2025 7:55am

[rkoron007]

Howdy @mrinalirao! Heads up that we will be migrating the content from terraform-docs-common into the UDR repo this week. I'm going through and merging any documentation PRs we can get in before migration, but for future work you'll need to recreate this PR over in the UDR repo after the migration is complete (and I'll leave a comment on all the associated Stacks PRs).

So a heads up, after the migration happens I'll close this PR and will let you know when you are good to recreate it! Apologies about the extra work you have to do though!

[rkoron007]

Hello @mrinalirao!

The UDR migration has occurred, and the HCP Terraform documentation version now lives in the unified documentation repository. I'm going to close this PR since we are no longer serving this content from this repo, but please feel free to recreate your PR in the UDR repository within the HCP Terraform documentation and tag me if you need a review:
https://github.com/hashicorp/web-unified-docs/tree/main/content/terraform-docs-common/docs/cloud-docs

[aaabdelgany]

I know the PR is closed but the content is good.

[aaabdelgany]

Can we leave this todo comment up? I think we're not going to render the runs here but I'm sure that's up in the air to some degree so we can double check when the apis are more finalized.

[aaabdelgany]

20 stacks

[aaabdelgany]

20 stacks