@postman-cse/onboarding-api 0.10.1 → 0.12.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 +3 -1
  2. package/action.yml +9 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -127,6 +127,7 @@ Even when reusing an existing `spec-id`, the composite action still requires `sp
127
127
  | `baseline-collection-id` | | Reuse an existing baseline collection. |
128
128
  | `smoke-collection-id` | | Reuse an existing smoke collection. |
129
129
  | `contract-collection-id` | | Reuse an existing contract collection. |
130
+ | `sync-examples` | `true` | Whether linked spec/collection relations should enable example syncing during cloud linkage. |
130
131
  | `collection-sync-mode` | `refresh` | Collection lifecycle policy. `refresh` regenerates from latest spec (default), `reuse` keeps existing, `version` creates release-scoped collections. |
131
132
  | `spec-sync-mode` | `update` | Spec lifecycle policy. `update` keeps canonical spec current, `version` creates release-scoped spec. |
132
133
  | `release-label` | | Optional release label for versioned specs and collections. Derived from git tag/branch when omitted. |
@@ -142,6 +143,7 @@ Even when reusing an existing `spec-id`, the composite action still requires `sp
142
143
  | `workspace-admin-user-ids` | | Optional comma-separated workspace admin IDs. |
143
144
  | `workspace-team-id` | | Numeric sub-team ID for org-mode workspace creation. |
144
145
  | `spec-url` | | Required registry-backed OpenAPI document URL. |
146
+ | `spec-path` | | Optional repo-root-relative path to the local spec file used for repo metadata generation. |
145
147
  | `environments-json` | `["prod"]` | Environment slugs to materialize downstream. |
146
148
  | `system-env-map-json` | `{}` | Map of environment slug to system environment ID. |
147
149
  | `governance-mapping-json` | `{}` | Map of domain to governance group name. |
@@ -232,7 +234,7 @@ The composite action wires:
232
234
  - `workspace-id`, `workspace-url`, `spec-id`, and `collections-json` from `bootstrap`.
233
235
  - `environment-uids-json`, `mock-url`, `monitor-id`, `repo-sync-summary-json`, and `commit-sha` from `repo_sync`.
234
236
  - Existing-service passthrough inputs to `bootstrap`: `workspace-id`, `spec-id`, `baseline-collection-id`, `smoke-collection-id`, and `contract-collection-id`.
235
- - Existing-repo passthrough inputs to `repo_sync`: `generate-ci-workflow` and `ci-workflow-path`.
237
+ - Existing-repo passthrough inputs to `repo_sync`: `generate-ci-workflow`, `ci-workflow-path`, and `spec-path`.
236
238
  - When `enable-insights: true`, the Insights onboarding step runs after repo sync using the workspace ID from bootstrap plus the first environment from `environments-json` for `environment-id` and `system-env-map-json` lookup.
237
239
  - Insights outputs (`insights-status`, `insights-verification-token`, `insights-application-id`, `insights-discovered-service-id`, `insights-discovered-service-name`, `insights-collection-id`) are surfaced when `enable-insights: true`.
238
240
 
package/action.yml CHANGED
@@ -17,6 +17,10 @@ inputs:
17
17
  contract-collection-id:
18
18
  description: Existing contract collection ID.
19
19
  required: false
20
+ sync-examples:
21
+ description: Whether linked spec/collection relations should enable example syncing.
22
+ required: false
23
+ default: 'true'
20
24
  collection-sync-mode:
21
25
  description: Collection lifecycle policy (reuse, refresh, or version). Default refresh ensures collections stay in sync with the spec.
22
26
  required: false
@@ -64,6 +68,9 @@ inputs:
64
68
  spec-url:
65
69
  description: URL to the OpenAPI document to bootstrap.
66
70
  required: true
71
+ spec-path:
72
+ description: Optional repo-root-relative path to the local spec file for repo metadata generation.
73
+ required: false
67
74
  environments-json:
68
75
  description: JSON array of environment slugs to materialize.
69
76
  required: false
@@ -201,6 +208,7 @@ runs:
201
208
  baseline-collection-id: ${{ inputs.baseline-collection-id }}
202
209
  smoke-collection-id: ${{ inputs.smoke-collection-id }}
203
210
  contract-collection-id: ${{ inputs.contract-collection-id }}
211
+ sync-examples: ${{ inputs.sync-examples }}
204
212
  collection-sync-mode: ${{ inputs.collection-sync-mode }}
205
213
  spec-sync-mode: ${{ inputs.spec-sync-mode }}
206
214
  release-label: ${{ inputs.release-label }}
@@ -251,6 +259,7 @@ runs:
251
259
  ssl-client-passphrase: ${{ inputs.ssl-client-passphrase }}
252
260
  ssl-extra-ca-certs: ${{ inputs.ssl-extra-ca-certs }}
253
261
  spec-id: ${{ steps.bootstrap.outputs.spec-id }}
262
+ spec-path: ${{ inputs.spec-path }}
254
263
  - id: insights_onboarding
255
264
  if: inputs.enable-insights == 'true'
256
265
  name: Onboard Postman Insights
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman-cse/onboarding-api",
3
- "version": "0.10.1",
3
+ "version": "0.12.0",
4
4
  "description": "Public open-alpha composite Postman API onboarding GitHub Action.",
5
5
  "files": [
6
6
  "action.yml",