postman-cs/Postman Onboarding: Smoke Flow

Apply a curated flow.yaml to the generated Postman Smoke collection. Part of the Postman API Onboarding suite.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
project-nameService project name used for temporary smoke collection naming.yes
workspace-idPostman workspace ID produced by bootstrap.yes
spec-idPostman spec ID produced by bootstrap.yes
smoke-collection-idCanonical Smoke collection ID to refresh in place.yes
flow-pathOptional repo-root-relative path to the curated flow.yaml manifest. When omitted, the canonical Smoke collection is refreshed from the generated spec collection without flow curation.no
postman-api-keyOptional service-account API key. Only used to re-mint an expired postman-access-token; the collection reshape itself runs access-token-only through the Postman gateway.no
postman-regionPostman data residency region for public API calls. Supported values are us and eu.nous
auth-config-jsonAdvanced low-level Smoke runtime auth JSON, usually generated by onboarding templates from smoke.apiKey or smoke.oauth config. Supports OAuth2 client credentials and API key auth.no
secrets-resolver-enabledWhether to include the legacy AWS Secrets Manager resolver item at the start of the generated Smoke collection. Defaults to true for backward compatibility; set to false to opt out.notrue
spec-pathOptional repo-root-relative path to the local OpenAPI spec for validation and debug context.no
debug-dump-pathOptional repo-root-relative or absolute path to write the transformed collection JSON before update.no
collection-sync-modeCollection lifecycle policy. Refresh is the supported v1 mode.norefresh
postman-access-tokenService-account access token (x-access-token) that authenticates the Smoke collection reshape against the Postman gateway. Required for the reshape; when omitted, the action mints one from postman-api-key (service-account PMAK).no
fail-on-flow-warningWhether non-blocking flow warnings should fail the action.nofalse
keep-temp-collection-on-failureWhether to keep the generated temporary smoke collection for debugging after a failed apply.nofalse
temp-collection-prefixPrefix used when generating the temporary smoke collection from the spec.no[Smoke][Temp]
team-idOptional Postman team ID, used only to attribute non-identifying usage telemetry to your team. The action runs identically with or without it.no
branch-strategyBranch-aware sync strategy. legacy (default) keeps branch-blind behavior; publish-gate restricts canonical writes to the canonical branch and skips on other branches; preview additionally maintains suffixed per-branch preview asset sets.nolegacy
canonical-branchExplicit canonical branch (the sole writer of canonical assets). Defaults to the provider-resolved default branch; required on providers without a default-branch variable (Bitbucket, Azure DevOps) when branch-strategy is not legacy.no
channelsComma-separated channel map for long-lived promotion branches, e.g. "develop=DEV, staging=STAGE, release/*=RC".no
namedescription
smoke-collection-idCanonical Smoke collection ID after curated flow application.
flow-apply-statusFlow apply result status.
flow-apply-summary-jsonJSON summary of flow application results and warnings.
temporary-smoke-collection-idTemporary generated smoke collection ID used during apply.
flow-step-countNumber of steps in the applied flow.
resolved-operation-countNumber of flow steps resolved to generated requests.
applied-binding-countNumber of bindings applied as prerequest logic.
applied-extract-countNumber of extracts applied as test logic.
assertion-countNumber of generated assertions applied across flow steps.
sync-statusBranch-aware sync status: synced, skipped-branch-gate, or empty under branch-strategy legacy.
branch-decisionSerialized BranchDecision JSON for downstream actions (also exported as POSTMAN_BRANCH_DECISION).