@postman-cs/onboarding-api 3.5.16 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +1 -0
  2. package/action.yml +12 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -348,6 +348,7 @@ The hook only attaches `x-api-key` for `*.mock.pstmn.io` hosts, so it stays iner
348
348
  | `flow-path` | Optional path to the smoke flow.yaml manifest, relative to working-directory when set, otherwise the repository root, defaulting to postman/flow.yaml inside the wrapped action. When set, the composite chains postman-cs/postman-smoke-flow-action before repo sync: a manifest at the effective path drives a curated reshape of the canonical Smoke collection, and under flow-mode auto a missing manifest is derived from spec-path and persisted to that path so repo sync commits it and the next run takes the curated path. Leave empty (default) to skip the smoke-flow step unless flow-mode requests it. | no | |
349
349
  | `flow-mode` | Optional flow selection policy forwarded to postman-cs/postman-smoke-flow-action. Set to auto to run the smoke-flow step without a curated manifest: it derives a deterministic smoke flow from spec-path (create before read, output-to-input bindings resolved by provenance) and persists it to the effective flow path for repo sync to commit. Set to curated to require flow-path, or off to refresh the canonical Smoke collection without curation. Leave empty (default) to run the smoke-flow step only when flow-path is set, preserving the pre-flow-mode contract. | no | |
350
350
  | `flow-allow-delete` | Whether a derived smoke flow may include DELETE operations whose identifiers are proven to originate from the same run's create steps. Forwarded to postman-cs/postman-smoke-flow-action; ignored for curated manifests. Defaults to false. | no | `false` |
351
+ | `flow-derive-scope` | Scope for smoke flows derived under flow-mode auto. full (default) chains create -> list -> read -> update from create-response identifiers. read-only derives GET operations only and feeds item-path identifiers from the first item of the owning resource's list response, so no POST, PUT, PATCH, or DELETE is sent. Forwarded to postman-cs/postman-smoke-flow-action; ignored for curated manifests. | no | `full` |
351
352
  | `persist-derived-flow` | Whether a freshly derived smoke flow is written to the effective flow path (flow-path or postman/flow.yaml) after a successful apply, so repo sync commits it and the next run is curated. Forwarded to postman-cs/postman-smoke-flow-action; create-only, never overwrites an existing manifest. Set false to derive without persisting. | no | `true` |
352
353
  | `enable-insights` | Whether to enable Postman Insights. | no | `false` |
353
354
  | `skip-built-in-tests` | When 'true', skip the built-in smoke and contract Postman CLI test run and JUnit artifact upload that normally happen inside this action. Set this to 'true' when the caller workflow needs to perform additional post-onboarding setup (e.g. bearer-token injection, mTLS bootstrap, vault-hydrated secrets, dynamic env enrichment) before the smoke and contract suites can authenticate successfully, and will run the tests itself afterward. Default 'false' preserves existing behavior for all current callers. | no | `false` |
package/action.yml CHANGED
@@ -261,6 +261,16 @@ inputs:
261
261
  manifests. Defaults to false.
262
262
  required: false
263
263
  default: 'false'
264
+ flow-derive-scope:
265
+ description: |
266
+ Scope for smoke flows derived under flow-mode auto. full (default)
267
+ chains create -> list -> read -> update from create-response
268
+ identifiers. read-only derives GET operations only and feeds item-path
269
+ identifiers from the first item of the owning resource's list
270
+ response, so no POST, PUT, PATCH, or DELETE is sent. Forwarded to
271
+ postman-cs/postman-smoke-flow-action; ignored for curated manifests.
272
+ required: false
273
+ default: 'full'
264
274
  persist-derived-flow:
265
275
  description: |
266
276
  Whether a freshly derived smoke flow is written to the effective flow
@@ -801,6 +811,7 @@ runs:
801
811
  flow-path: ${{ inputs.flow-path }}
802
812
  flow-mode: ${{ inputs.flow-mode == '' && 'auto' || inputs.flow-mode }}
803
813
  flow-allow-delete: ${{ inputs.flow-allow-delete }}
814
+ flow-derive-scope: ${{ inputs.flow-derive-scope }}
804
815
  persist-derived-flow: ${{ inputs.persist-derived-flow }}
805
816
  spec-path: ${{ inputs.spec-path }}
806
817
  postman-api-key: ${{ steps.branch_decision.outputs.tier != 'gated' && inputs.postman-api-key || '' }}
@@ -813,7 +824,7 @@ runs:
813
824
  - id: repo_sync
814
825
  name: Sync Repository and Workspace
815
826
  if: ${{ steps.branch_decision.outputs.tier != 'gated' }}
816
- uses: postman-cs/postman-repo-sync-action@v2.11.2
827
+ uses: postman-cs/postman-repo-sync-action@v3.0.1
817
828
  env:
818
829
  POSTMAN_TEAM_ID: ${{ inputs.postman-team-id }}
819
830
  POSTMAN_BRANCH_DECISION: ${{ steps.branch_decision.outputs.branch-decision }}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman-cs/onboarding-api",
3
- "version": "3.5.16",
3
+ "version": "4.1.0",
4
4
  "description": "Composite Postman API onboarding GitHub Action.",
5
5
  "files": [
6
6
  "action.yml",