Skip to content

3. Add docs for stack deployment runs and steps apis #481

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.

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 1 commit into
base: mr/stacks-api-ga
Choose a base branch
from

Conversation

mrinalirao
Copy link

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

#471
#480

This PR adds API docs for stack deployment runs and stack deployment steps.
https://hashicorp.atlassian.net/browse/TF-26297

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 /stack-deployment-groups/{stack_deployment_group_id}/stack-deployment-runs
2. GET /stack-deployment-runs/{stack_deployment_run_id}
3. POST /stack-deployment-runs/{stack_deployment_run_id}/approve-all-plans
4. POST /stack-deployment-runs/{stack_deployment_run_id}/cancel
5. GET /stack-deployment-runs/{stack_deployment_run_id}/stack-deployment-steps
6. GET /stack-deployment-steps/{stack_deployment_step_id}
7. GET /stack-deployment-steps/{stack_deployment_step_id}/stack-diagnostics
8. POST /stack-deployment-steps/{stack_deployment_step_id}/advance
9. POST /stack-deployment-steps/{stack_deployment_step_id}/fail

@mrinalirao mrinalirao changed the title Add docs for stack deployment runs and steps apis 3. Add docs for stack deployment runs and steps apis Jun 11, 2025
@mrinalirao mrinalirao requested a review from aaabdelgany June 11, 2025 23:34
## List stack deployment steps

/*TODO: For reviewer - check if the plan-description, apply-description and structured-logs links look ok or need to be fixed */

Choose a reason for hiding this comment

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

I think these will need to be reworked - I expect that they will be moved under the DeploymentStep model. We should leave this comment up so we can double check before GA

@mrinalirao mrinalirao changed the base branch from mr/stacks-deployment-api to mr/stacks-api-ga June 12, 2025 23:13
@mrinalirao mrinalirao marked this pull request as ready for review June 12, 2025 23:14
@mrinalirao mrinalirao requested a review from a team as a code owner June 12, 2025 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants