Skip to content

[Feature Request] Add Stack Deployment Runs API Specs #152

@isivaselvan

Description

@isivaselvan

Use-cases

StackDeploymentRuns describes all the stack-deployment-runs related methods that the HCP Terraform API supports.

  • List (by group) returns a list of deployment runs within a specific deployment group.
  • List (by configuration) returns a list of deployment runs across an entire stack configuration.
  • Read retrieves a single deployment run by its ID.
  • ReadWithOptions retrieves a deployment run by ID with optional related resources included (e.g. stack-deployment-group, stack-approval, current-step, blocked-by-deployment-group).
  • ApproveAllPlans approves all current and future plans associated with a deployment run.
  • Cancel cancels an in-progress deployment run, with an optional force flag.

Attempted Solutions

None, Currently not supported

Proposal

Add support for Stack Deployment Runs as a new resource family in python-tfe.

All new code should follow existing project conventions:

  • Pydantic v2 models with populate_by_name=True
  • alias-based JSON:API field mapping
  • _Service base class
  • Iterator-based pagination via _list.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for Feature.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions