@postman-cs/onboarding-api 4.0.0 → 4.2.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.
- package/README.md +4 -0
- package/action.yml +26 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -295,6 +295,9 @@ The hook only attaches `x-api-key` for `*.mock.pstmn.io` hosts, so it stays iner
|
|
|
295
295
|
| `sync-examples` | Whether linked spec/collection relations should enable example syncing. | no | `true` |
|
|
296
296
|
| `collection-sync-mode` | Collection lifecycle policy (refresh or version). Default refresh ensures tracked collections stay in sync with the spec. | no | `refresh` |
|
|
297
297
|
| `collection-update-strategy` | Collection update strategy (auto or whole). Default whole preserves full collection updates. | no | `whole` |
|
|
298
|
+
| `folder-strategy` | Folder organization strategy for generated collections (Paths or Tags). Forwarded to postman-cs/postman-bootstrap-action. | no | `Paths` |
|
|
299
|
+
| `nested-folder-hierarchy` | When folder-strategy is Tags, enables nested folder hierarchy for generated collections. Forwarded to postman-cs/postman-bootstrap-action. | no | `false` |
|
|
300
|
+
| `request-name-source` | Determines how requests are named in generated collections (Fallback or URL). Forwarded to postman-cs/postman-bootstrap-action. | no | `Fallback` |
|
|
298
301
|
| `spec-sync-mode` | Spec lifecycle policy (update or version). | no | `update` |
|
|
299
302
|
| `release-label` | Optional release label for versioned specs and collections. When omitted during versioned sync, derived from GitHub tag or branch metadata. | no | |
|
|
300
303
|
| `monitor-id` | Existing smoke monitor ID. When set, the action validates and reuses this monitor instead of creating a new one. | no | |
|
|
@@ -348,6 +351,7 @@ The hook only attaches `x-api-key` for `*.mock.pstmn.io` hosts, so it stays iner
|
|
|
348
351
|
| `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
352
|
| `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
353
|
| `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` |
|
|
354
|
+
| `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
355
|
| `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
356
|
| `enable-insights` | Whether to enable Postman Insights. | no | `false` |
|
|
353
357
|
| `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
|
@@ -40,6 +40,18 @@ inputs:
|
|
|
40
40
|
description: Collection update strategy (auto or whole). Default whole preserves full collection updates.
|
|
41
41
|
required: false
|
|
42
42
|
default: whole
|
|
43
|
+
folder-strategy:
|
|
44
|
+
description: Folder organization strategy for generated collections (Paths or Tags). Forwarded to postman-cs/postman-bootstrap-action.
|
|
45
|
+
required: false
|
|
46
|
+
default: Paths
|
|
47
|
+
nested-folder-hierarchy:
|
|
48
|
+
description: When folder-strategy is Tags, enables nested folder hierarchy for generated collections. Forwarded to postman-cs/postman-bootstrap-action.
|
|
49
|
+
required: false
|
|
50
|
+
default: 'false'
|
|
51
|
+
request-name-source:
|
|
52
|
+
description: Determines how requests are named in generated collections (Fallback or URL). Forwarded to postman-cs/postman-bootstrap-action.
|
|
53
|
+
required: false
|
|
54
|
+
default: Fallback
|
|
43
55
|
spec-sync-mode:
|
|
44
56
|
description: Spec lifecycle policy (update or version).
|
|
45
57
|
required: false
|
|
@@ -261,6 +273,16 @@ inputs:
|
|
|
261
273
|
manifests. Defaults to false.
|
|
262
274
|
required: false
|
|
263
275
|
default: 'false'
|
|
276
|
+
flow-derive-scope:
|
|
277
|
+
description: |
|
|
278
|
+
Scope for smoke flows derived under flow-mode auto. full (default)
|
|
279
|
+
chains create -> list -> read -> update from create-response
|
|
280
|
+
identifiers. read-only derives GET operations only and feeds item-path
|
|
281
|
+
identifiers from the first item of the owning resource's list
|
|
282
|
+
response, so no POST, PUT, PATCH, or DELETE is sent. Forwarded to
|
|
283
|
+
postman-cs/postman-smoke-flow-action; ignored for curated manifests.
|
|
284
|
+
required: false
|
|
285
|
+
default: 'full'
|
|
264
286
|
persist-derived-flow:
|
|
265
287
|
description: |
|
|
266
288
|
Whether a freshly derived smoke flow is written to the effective flow
|
|
@@ -749,6 +771,9 @@ runs:
|
|
|
749
771
|
sync-examples: ${{ inputs.sync-examples }}
|
|
750
772
|
collection-sync-mode: ${{ inputs.collection-sync-mode }}
|
|
751
773
|
collection-update-strategy: ${{ inputs.collection-update-strategy }}
|
|
774
|
+
folder-strategy: ${{ inputs.folder-strategy }}
|
|
775
|
+
nested-folder-hierarchy: ${{ inputs.nested-folder-hierarchy }}
|
|
776
|
+
request-name-source: ${{ inputs.request-name-source }}
|
|
752
777
|
spec-sync-mode: ${{ inputs.spec-sync-mode }}
|
|
753
778
|
release-label: ${{ inputs.release-label }}
|
|
754
779
|
domain: ${{ inputs.domain }}
|
|
@@ -801,6 +826,7 @@ runs:
|
|
|
801
826
|
flow-path: ${{ inputs.flow-path }}
|
|
802
827
|
flow-mode: ${{ inputs.flow-mode == '' && 'auto' || inputs.flow-mode }}
|
|
803
828
|
flow-allow-delete: ${{ inputs.flow-allow-delete }}
|
|
829
|
+
flow-derive-scope: ${{ inputs.flow-derive-scope }}
|
|
804
830
|
persist-derived-flow: ${{ inputs.persist-derived-flow }}
|
|
805
831
|
spec-path: ${{ inputs.spec-path }}
|
|
806
832
|
postman-api-key: ${{ steps.branch_decision.outputs.tier != 'gated' && inputs.postman-api-key || '' }}
|