picked 0.0.101 → 0.0.102-next.2

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 (36) hide show
  1. package/docs/reference/dashboard/workflow-test-runs.md +40 -17
  2. package/docs/reference/management-api/schema/action.md +67 -79
  3. package/docs/reference/management-api/schema/analytics-session.md +77 -94
  4. package/docs/reference/management-api/schema/analytics.md +16 -14
  5. package/docs/reference/management-api/schema/api-key.md +43 -51
  6. package/docs/reference/management-api/schema/auth.md +271 -404
  7. package/docs/reference/management-api/schema/cms-fields.md +348 -245
  8. package/docs/reference/management-api/schema/cms-models.md +369 -378
  9. package/docs/reference/management-api/schema/common.md +69 -130
  10. package/docs/reference/management-api/schema/condition.md +63 -74
  11. package/docs/reference/management-api/schema/design-system.md +59 -51
  12. package/docs/reference/management-api/schema/experience.md +388 -364
  13. package/docs/reference/management-api/schema/external-api.md +153 -171
  14. package/docs/reference/management-api/schema/feature.md +85 -103
  15. package/docs/reference/management-api/schema/feedback.md +27 -31
  16. package/docs/reference/management-api/schema/field.md +117 -135
  17. package/docs/reference/management-api/schema/index.md +184 -184
  18. package/docs/reference/management-api/schema/integration.md +72 -78
  19. package/docs/reference/management-api/schema/label.md +81 -137
  20. package/docs/reference/management-api/schema/lead.md +80 -119
  21. package/docs/reference/management-api/schema/mcp-server.md +73 -71
  22. package/docs/reference/management-api/schema/metric.md +6 -9
  23. package/docs/reference/management-api/schema/operation.md +17 -26
  24. package/docs/reference/management-api/schema/organization.md +198 -220
  25. package/docs/reference/management-api/schema/project.md +177 -186
  26. package/docs/reference/management-api/schema/report.md +69 -65
  27. package/docs/reference/management-api/schema/saved-view.md +71 -71
  28. package/docs/reference/management-api/schema/shopify.md +331 -204
  29. package/docs/reference/management-api/schema/step.md +72 -80
  30. package/docs/reference/management-api/schema/tenant-branding.md +48 -70
  31. package/docs/reference/management-api/schema/workbench.md +54 -66
  32. package/docs/reference/management-api/schema/workflow-run.md +66 -79
  33. package/docs/reference/management-api/schema/workflow.md +310 -353
  34. package/docs/reference/management-api/schema/workspace-version.md +212 -261
  35. package/docs/reference/management-api/schema/workspace.md +275 -328
  36. package/package.json +4 -4
@@ -6,17 +6,16 @@ generated: true
6
6
 
7
7
  # Workspace version schema
8
8
 
9
- The operations and types that `workspace-version.graphql` adds to the Management API. See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
9
+ See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
10
10
 
11
11
  ## Queries
12
12
 
13
13
  ### `workspaceDiff`
14
14
 
15
- Compute a structural diff between two workspace snapshots. Each side
16
- can be either a live workspace (diffed against its current draft
17
- snapshot) or a previously-published `WorkspaceVersion`. Requires
18
- authentication and `ORGANIZATION_PROJECTS_READ` scope on the project
19
- shared by both sides.
15
+ Compares two workspace snapshots and lists the entities added, removed and modified. Each side is
16
+ a workspace at its current content or a published version, and both sides must belong to one
17
+ project.
18
+ Scope: `ORGANIZATION_WORKSPACE_READ`.
20
19
 
21
20
  ```graphql
22
21
  workspaceDiff(input: WorkspaceDiffInput!): WorkspaceDiffPayload! @auth
@@ -28,31 +27,26 @@ workspaceDiff(input: WorkspaceDiffInput!): WorkspaceDiffPayload! @auth
28
27
 
29
28
  ```graphql
30
29
  """
31
- An immutable snapshot of a workspace's config at publish time. Created
32
- by `workspacePublish`; never modified after creation.
33
-
34
- Snapshot contents (the underlying `config_json` blob) are deliberately
35
- not exposed via this type. To inspect the contents, use `workspaceDiff`
36
- to compare a snapshot against another snapshot or against the current
37
- draft.
30
+ An immutable snapshot of a workspace, made when the workspace is published. Read its contents
31
+ through `workspaceDiff`.
38
32
  """
39
33
  type WorkspaceVersion {
40
- """Unique snapshot identifier."""
34
+ """The ID of the version."""
41
35
  id: ID!
42
- """The workspace this snapshot belongs to."""
36
+ """The ID of the workspace the version was published from."""
43
37
  workspaceId: ID!
44
- """The workspace this snapshot was published from."""
38
+ """The workspace the version was published from."""
45
39
  workspace: Workspace!
46
- """Id of the hidden workspace duplicated at publish time, if one exists."""
40
+ """
41
+ The ID of the version's snapshot workspace. Null when the version has none.
42
+ """
47
43
  snapshotWorkspaceId: ID
48
44
  """
49
- The hidden workspace duplicated from the published workspace at publish
50
- time — the editable state behind this version, opened by Publish History's
51
- Restore action. Null on versions published before snapshots existed, when
52
- snapshot duplication failed, or after the snapshot workspace was deleted.
45
+ The hidden copy of the workspace made when the version was published, which restoring the
46
+ version opens. Null when the version has none or the copy was deleted.
53
47
  """
54
48
  snapshotWorkspace: Workspace
55
- """When this snapshot was published."""
49
+ """When the version was published."""
56
50
  publishedAt: DateTime!
57
51
  }
58
52
  ```
@@ -60,11 +54,11 @@ type WorkspaceVersion {
60
54
  ### `WorkspaceVersionEdge`
61
55
 
62
56
  ```graphql
63
- """Edge type for `WorkspaceVersionConnection`."""
57
+ """A workspace version in a page of results."""
64
58
  type WorkspaceVersionEdge {
65
- """Pagination cursor for this edge."""
59
+ """The cursor of this edge."""
66
60
  cursor: String!
67
- """The workspace version."""
61
+ """The item."""
68
62
  node: WorkspaceVersion!
69
63
  }
70
64
  ```
@@ -72,15 +66,13 @@ type WorkspaceVersionEdge {
72
66
  ### `WorkspaceVersionConnection`
73
67
 
74
68
  ```graphql
75
- """
76
- Relay-style connection of workspace versions, ordered newest-first by `publishedAt`.
77
- """
69
+ """A page of workspace versions."""
78
70
  type WorkspaceVersionConnection {
79
- """List of workspace-version edges."""
71
+ """The edges in this page."""
80
72
  edges: [WorkspaceVersionEdge!]!
81
- """Pagination metadata."""
73
+ """Where this page sits in the list."""
82
74
  pageInfo: PageInfo!
83
- """Total number of published versions for the workspace."""
75
+ """The number of items across all pages."""
84
76
  totalCount: Int!
85
77
  }
86
78
  ```
@@ -89,24 +81,17 @@ type WorkspaceVersionConnection {
89
81
 
90
82
  ```graphql
91
83
  """
92
- Input for `workspaceDiff`. Each side resolves to a snapshot: either a
93
- live workspace (diffed against its current draft snapshot) or a
94
- previously-published `WorkspaceVersion`.
95
-
96
- Exactly one of `baseWorkspaceId` / `baseWorkspaceVersionId` must be set,
97
- and exactly one of `compareWorkspaceId` / `compareWorkspaceVersionId`
98
- must be set. Both sides must resolve to the same project.
84
+ The input of `workspaceDiff`. Each side is a workspace, at its current content, or a published
85
+ version. Set exactly one field per side.
99
86
  """
100
87
  input WorkspaceDiffInput {
101
- """Base-side live workspace (diffed against its current draft snapshot)."""
88
+ """The workspace to compare from."""
102
89
  baseWorkspaceId: ID
103
- """Base-side published workspace version."""
90
+ """The version to compare from."""
104
91
  baseWorkspaceVersionId: ID
105
- """
106
- Compare-side live workspace (diffed against its current draft snapshot).
107
- """
92
+ """The workspace to compare to."""
108
93
  compareWorkspaceId: ID
109
- """Compare-side published workspace version."""
94
+ """The version to compare to."""
110
95
  compareWorkspaceVersionId: ID
111
96
  }
112
97
  ```
@@ -114,12 +99,14 @@ input WorkspaceDiffInput {
114
99
  ### `WorkspaceDiffPayload`
115
100
 
116
101
  ```graphql
117
- """Payload returned by `workspaceDiff`."""
102
+ """The result of `workspaceDiff`."""
118
103
  type WorkspaceDiffPayload {
119
- """The computed diff, or null when a `userError` was returned."""
104
+ """The diff. Null when a `userError` was returned."""
120
105
  diff: WorkspaceDiff
121
106
  """
122
- Validation, authorisation, and referential-integrity errors. Empty array indicates success.
107
+ The problems that stopped the diff, with codes `INVALID_INPUT`, `WORKSPACE_NOT_FOUND`,
108
+ `WORKSPACE_VERSION_NOT_FOUND`, `PROJECT_NOT_FOUND`, `CROSS_PROJECT_COMPARISON_UNSUPPORTED` and
109
+ `FORBIDDEN`. Empty on success.
123
110
  """
124
111
  userErrors: [UserError!]!
125
112
  }
@@ -128,20 +115,16 @@ type WorkspaceDiffPayload {
128
115
  ### `WorkspaceSnapshotSummary`
129
116
 
130
117
  ```graphql
131
- """
132
- Identifies a snapshot on one side of a diff — workspace id plus optional version id and publish time.
133
- """
118
+ """One side of a diff."""
134
119
  type WorkspaceSnapshotSummary {
135
- """
136
- The workspace the snapshot belongs to (for both live workspaces and published versions).
137
- """
120
+ """The ID of the workspace the side belongs to."""
138
121
  workspaceId: ID!
139
122
  """
140
- The workspace-version id, when this side resolves to a published version.
123
+ The ID of the version. Null when the side is a workspace's current content.
141
124
  """
142
125
  workspaceVersionId: ID
143
126
  """
144
- When the snapshot was published, when this side resolves to a published version.
127
+ When the version was published. Null when the side is a workspace's current content.
145
128
  """
146
129
  publishedAt: DateTime
147
130
  }
@@ -151,40 +134,35 @@ type WorkspaceSnapshotSummary {
151
134
 
152
135
  ```graphql
153
136
  """
154
- A workspace-level structural diff between two snapshots. Each top-level
155
- section enumerates entities that were added, removed, or modified for
156
- one entity kind.
157
-
158
- `hasChanges` is `true` iff any per-entity section is non-empty —
159
- convenient for showing a "no changes to publish" CTA without scanning
160
- every section.
137
+ What differs between two workspace snapshots, one section per kind of entity. Each section lists
138
+ the entities added, removed and modified.
161
139
  """
162
140
  type WorkspaceDiff {
163
- """Identifier information for the base snapshot."""
141
+ """The side compared from."""
164
142
  base: WorkspaceSnapshotSummary!
165
- """Identifier information for the compare snapshot."""
143
+ """The side compared to."""
166
144
  compare: WorkspaceSnapshotSummary!
167
- """True iff any per-entity section is non-empty."""
145
+ """Whether any section lists an entity."""
168
146
  hasChanges: Boolean!
169
- """Per-entity feature differences."""
147
+ """The feature flags that differ."""
170
148
  features: FeatureDiff!
171
- """Per-entity step differences."""
149
+ """The steps that differ."""
172
150
  steps: StepDiff!
173
- """Per-entity field differences."""
151
+ """The fields that differ."""
174
152
  fields: FieldDiff!
175
- """Per-entity action differences."""
153
+ """The actions that differ."""
176
154
  actions: ActionDiff!
177
- """Per-entity condition differences."""
155
+ """The conditions that differ."""
178
156
  conditions: ConditionDiff!
179
- """Per-entity experience differences."""
157
+ """The experiences that differ."""
180
158
  experiences: ExperienceDiff!
181
- """Per-entity CMS Content Model differences."""
159
+ """The Content Models that differ."""
182
160
  contentModels: ContentModelDiff!
183
- """Per-entity CMS Content Block differences."""
161
+ """The Content Blocks that differ."""
184
162
  contentBlocks: ContentBlockDiff!
185
- """Per-entity CMS Content Entry differences."""
163
+ """The content entries that differ."""
186
164
  contentEntries: ContentEntryDiff!
187
- """Per-entity workflow differences."""
165
+ """The workflows that differ."""
188
166
  workflows: WorkflowDiff!
189
167
  }
190
168
  ```
@@ -192,13 +170,13 @@ type WorkspaceDiff {
192
170
  ### `PropertyChange`
193
171
 
194
172
  ```graphql
195
- """A scalar or JSON-valued property that changed between two snapshots."""
173
+ """A property whose value differs between the two snapshots."""
196
174
  type PropertyChange {
197
- """The property name on the parent entity (e.g. `name`, `weight`)."""
175
+ """The property's name, such as `name` or `weight`."""
198
176
  property: String!
199
- """The base snapshot's value, as JSON."""
177
+ """The value in the base snapshot."""
200
178
  base: JSON
201
- """The compare snapshot's value, as JSON."""
179
+ """The value in the compare snapshot."""
202
180
  compare: JSON
203
181
  }
204
182
  ```
@@ -207,17 +185,15 @@ type PropertyChange {
207
185
 
208
186
  ```graphql
209
187
  """
210
- A structural change to a JSON subtree (conditions' `logic`, fields'
211
- `validation`, Content Model schemas). Presented as two opaque JSON
212
- values rather than a fine-grained path diff — clients render their own
213
- visualisations.
188
+ A JSON subtree that differs between the two snapshots, such as a condition's `logic` or a field's
189
+ `validation`, given whole from each side.
214
190
  """
215
191
  type LogicChange {
216
- """Which subtree changed (e.g. `logic`, `validation`)."""
192
+ """The subtree's name, such as `logic` or `validation`."""
217
193
  property: String!
218
- """Base snapshot's subtree."""
194
+ """The subtree in the base snapshot."""
219
195
  base: JSON
220
- """Compare snapshot's subtree."""
196
+ """The subtree in the compare snapshot."""
221
197
  compare: JSON
222
198
  }
223
199
  ```
@@ -225,16 +201,11 @@ type LogicChange {
225
201
  ### `FieldOptionSummary`
226
202
 
227
203
  ```graphql
228
- """
229
- A selectable option within a field, summarised for diff display. Named
230
- `FieldOptionSummary` (not `FieldOption`) because the workspace's
231
- `FieldOption` type carries a `JSON` `value`, whereas diffing keys by a
232
- string `value` identity.
233
- """
204
+ """A field option, as a diff lists it."""
234
205
  type FieldOptionSummary {
235
- """Option machine value (identity key for diff comparison)."""
206
+ """The option's value, which identifies it across snapshots."""
236
207
  value: String!
237
- """Option display label."""
208
+ """The option's label."""
238
209
  label: String!
239
210
  }
240
211
  ```
@@ -242,15 +213,13 @@ type FieldOptionSummary {
242
213
  ### `FieldOptionModification`
243
214
 
244
215
  ```graphql
245
- """
246
- An option whose label changed while the `value` identity stayed the same.
247
- """
216
+ """A field option whose label differs between the two snapshots."""
248
217
  type FieldOptionModification {
249
- """The option's unchanged identity key."""
218
+ """The option's value."""
250
219
  value: String!
251
- """Base snapshot's label."""
220
+ """The label in the base snapshot."""
252
221
  baseLabel: String!
253
- """Compare snapshot's label."""
222
+ """The label in the compare snapshot."""
254
223
  compareLabel: String!
255
224
  }
256
225
  ```
@@ -258,13 +227,13 @@ type FieldOptionModification {
258
227
  ### `FieldOptionsChange`
259
228
 
260
229
  ```graphql
261
- """Changes to a field's selectable options, keyed by option `value`."""
230
+ """How a field's options differ, matched by `value`."""
262
231
  type FieldOptionsChange {
263
232
  """Options present only in the compare snapshot."""
264
233
  added: [FieldOptionSummary!]!
265
234
  """Options present only in the base snapshot."""
266
235
  removed: [FieldOptionSummary!]!
267
- """Options whose `label` changed (same `value`)."""
236
+ """Options whose label differs."""
268
237
  modified: [FieldOptionModification!]!
269
238
  }
270
239
  ```
@@ -272,13 +241,13 @@ type FieldOptionsChange {
272
241
  ### `DiffStepRef`
273
242
 
274
243
  ```graphql
275
- """A reference to a step, used inside the diff payload."""
244
+ """A step, as a diff refers to it."""
276
245
  type DiffStepRef {
277
- """Stable id of the referenced step."""
246
+ """The ID of the step."""
278
247
  id: ID!
279
- """Display name from the snapshot."""
248
+ """Its name in the snapshot."""
280
249
  name: String!
281
- """Stable, human-readable key from the snapshot."""
250
+ """Its key in the snapshot."""
282
251
  key: String!
283
252
  }
284
253
  ```
@@ -286,13 +255,13 @@ type DiffStepRef {
286
255
  ### `DiffFieldRef`
287
256
 
288
257
  ```graphql
289
- """A reference to a field, used inside the diff payload."""
258
+ """A field, as a diff refers to it."""
290
259
  type DiffFieldRef {
291
- """Stable id of the referenced field."""
260
+ """The ID of the field."""
292
261
  id: ID!
293
- """Display name from the snapshot."""
262
+ """Its name in the snapshot."""
294
263
  name: String!
295
- """Stable, human-readable key from the snapshot."""
264
+ """Its key in the snapshot."""
296
265
  key: String!
297
266
  }
298
267
  ```
@@ -300,13 +269,13 @@ type DiffFieldRef {
300
269
  ### `DiffActionRef`
301
270
 
302
271
  ```graphql
303
- """A reference to an action, used inside the diff payload."""
272
+ """An action, as a diff refers to it."""
304
273
  type DiffActionRef {
305
- """Stable id of the referenced action."""
274
+ """The ID of the action."""
306
275
  id: ID!
307
- """Display name from the snapshot."""
276
+ """Its name in the snapshot."""
308
277
  name: String!
309
- """Stable, human-readable key from the snapshot."""
278
+ """Its key in the snapshot."""
310
279
  key: String!
311
280
  }
312
281
  ```
@@ -314,13 +283,13 @@ type DiffActionRef {
314
283
  ### `DiffConditionRef`
315
284
 
316
285
  ```graphql
317
- """A reference to a condition, used inside the diff payload."""
286
+ """A condition, as a diff refers to it."""
318
287
  type DiffConditionRef {
319
- """Stable id of the referenced condition."""
288
+ """The ID of the condition."""
320
289
  id: ID!
321
- """Display name from the snapshot."""
290
+ """Its name in the snapshot."""
322
291
  name: String!
323
- """Stable, human-readable key from the snapshot."""
292
+ """Its key in the snapshot."""
324
293
  key: String!
325
294
  }
326
295
  ```
@@ -328,11 +297,11 @@ type DiffConditionRef {
328
297
  ### `FlowStepRefsChange`
329
298
 
330
299
  ```graphql
331
- """Step refs added/removed from an experience's flow."""
300
+ """The steps added to or removed from an experience's flow."""
332
301
  type FlowStepRefsChange {
333
- """Step refs referenced only in the compare snapshot."""
302
+ """Steps only the compare snapshot's flow uses."""
334
303
  added: [DiffStepRef!]!
335
- """Step refs referenced only in the base snapshot."""
304
+ """Steps only the base snapshot's flow uses."""
336
305
  removed: [DiffStepRef!]!
337
306
  }
338
307
  ```
@@ -340,11 +309,11 @@ type FlowStepRefsChange {
340
309
  ### `FlowActionRefsChange`
341
310
 
342
311
  ```graphql
343
- """Action refs added/removed from an experience's flow."""
312
+ """The actions added to or removed from an experience's flow."""
344
313
  type FlowActionRefsChange {
345
- """Action refs referenced only in the compare snapshot."""
314
+ """Actions only the compare snapshot's flow uses."""
346
315
  added: [DiffActionRef!]!
347
- """Action refs referenced only in the base snapshot."""
316
+ """Actions only the base snapshot's flow uses."""
348
317
  removed: [DiffActionRef!]!
349
318
  }
350
319
  ```
@@ -352,11 +321,11 @@ type FlowActionRefsChange {
352
321
  ### `FlowConditionRefsChange`
353
322
 
354
323
  ```graphql
355
- """Condition refs added/removed from an experience's flow."""
324
+ """The conditions added to or removed from an experience's flow."""
356
325
  type FlowConditionRefsChange {
357
- """Condition refs referenced only in the compare snapshot."""
326
+ """Conditions only the compare snapshot's flow uses."""
358
327
  added: [DiffConditionRef!]!
359
- """Condition refs referenced only in the base snapshot."""
328
+ """Conditions only the base snapshot's flow uses."""
360
329
  removed: [DiffConditionRef!]!
361
330
  }
362
331
  ```
@@ -364,15 +333,13 @@ type FlowConditionRefsChange {
364
333
  ### `FieldRefsChange`
365
334
 
366
335
  ```graphql
367
- """
368
- `Step.fieldIds` change — added/removed field refs, plus an order-only flag.
369
- """
336
+ """How a step's fields differ."""
370
337
  type FieldRefsChange {
371
- """Field refs present only in the compare snapshot."""
338
+ """Fields only the compare snapshot's step holds."""
372
339
  added: [DiffFieldRef!]!
373
- """Field refs present only in the base snapshot."""
340
+ """Fields only the base snapshot's step holds."""
374
341
  removed: [DiffFieldRef!]!
375
- """True iff the same set of refs is present in a different order."""
342
+ """Whether the step holds the same fields in a different order."""
376
343
  reordered: Boolean!
377
344
  }
378
345
  ```
@@ -380,21 +347,17 @@ type FieldRefsChange {
380
347
  ### `ExperienceFlowChange`
381
348
 
382
349
  ```graphql
383
- """
384
- Summary of how an experience's flow graph changed. `structureChanged` is
385
- true when the graph (nodes/edges) differs beyond node/edge id renaming
386
- despite every referenced-entity set being equal — i.e. existing
387
- nodes/edges were re-arranged without changing what they reference.
388
- """
350
+ """How an experience's flow differs."""
389
351
  type ExperienceFlowChange {
390
- """Step ref changes, or null when unchanged."""
352
+ """The steps the flow added or removed. Null when they are the same."""
391
353
  stepRefsChange: FlowStepRefsChange
392
- """Action ref changes, or null when unchanged."""
354
+ """The actions the flow added or removed. Null when they are the same."""
393
355
  actionRefsChange: FlowActionRefsChange
394
- """Condition ref changes, or null when unchanged."""
356
+ """The conditions the flow added or removed. Null when they are the same."""
395
357
  conditionRefsChange: FlowConditionRefsChange
396
358
  """
397
- True iff nodes/edges differ beyond id renaming while all referenced-entity sets are equal.
359
+ Whether the nodes or edges were rearranged while the flow uses the same steps, actions and
360
+ conditions. Node and edge IDs are ignored.
398
361
  """
399
362
  structureChanged: Boolean!
400
363
  }
@@ -403,13 +366,13 @@ type ExperienceFlowChange {
403
366
  ### `FeatureDiffEntry`
404
367
 
405
368
  ```graphql
406
- """A feature's scalar property differences."""
369
+ """A feature flag whose properties differ."""
407
370
  type FeatureDiffEntry {
408
- """Feature id (stable across snapshots)."""
371
+ """The ID of the feature flag."""
409
372
  id: ID!
410
- """Display name of the feature, sourced from the compare snapshot."""
373
+ """Its name in the compare snapshot."""
411
374
  name: String!
412
- """Scalar property changes."""
375
+ """The properties that differ."""
413
376
  propertyChanges: [PropertyChange!]!
414
377
  }
415
378
  ```
@@ -417,13 +380,13 @@ type FeatureDiffEntry {
417
380
  ### `FeatureDiff`
418
381
 
419
382
  ```graphql
420
- """Feature section of the workspace diff."""
383
+ """The feature flags that differ between two snapshots."""
421
384
  type FeatureDiff {
422
- """Features present only in the compare snapshot."""
385
+ """Feature flags present only in the compare snapshot."""
423
386
  added: [JSON!]!
424
- """Features present only in the base snapshot."""
387
+ """Feature flags present only in the base snapshot."""
425
388
  removed: [JSON!]!
426
- """Features present in both snapshots but with differing properties."""
389
+ """Feature flags present in both snapshots, with differing properties."""
427
390
  modified: [FeatureDiffEntry!]!
428
391
  }
429
392
  ```
@@ -431,17 +394,17 @@ type FeatureDiff {
431
394
  ### `StepDiffEntry`
432
395
 
433
396
  ```graphql
434
- """A step's scalar property and field-ref differences."""
397
+ """A step whose properties or fields differ."""
435
398
  type StepDiffEntry {
436
- """Step id (stable across snapshots)."""
399
+ """The ID of the step."""
437
400
  id: ID!
438
- """Display name of the step, sourced from the compare snapshot."""
401
+ """Its name in the compare snapshot."""
439
402
  name: String!
440
- """Stable, human-readable key, sourced from the compare snapshot."""
403
+ """Its key in the compare snapshot."""
441
404
  key: String!
442
- """Scalar property changes."""
405
+ """The properties that differ."""
443
406
  propertyChanges: [PropertyChange!]!
444
- """Field-ref change (the step's `fieldIds`), or null when unchanged."""
407
+ """How the step's fields differ. Null when they are the same."""
445
408
  fieldRefsChange: FieldRefsChange
446
409
  }
447
410
  ```
@@ -449,13 +412,13 @@ type StepDiffEntry {
449
412
  ### `StepDiff`
450
413
 
451
414
  ```graphql
452
- """Step section of the workspace diff."""
415
+ """The steps that differ between two snapshots."""
453
416
  type StepDiff {
454
417
  """Steps present only in the compare snapshot."""
455
418
  added: [JSON!]!
456
419
  """Steps present only in the base snapshot."""
457
420
  removed: [JSON!]!
458
- """Steps present in both snapshots but with differing properties."""
421
+ """Steps present in both snapshots, with differing properties."""
459
422
  modified: [StepDiffEntry!]!
460
423
  }
461
424
  ```
@@ -463,21 +426,21 @@ type StepDiff {
463
426
  ### `FieldDiffEntry`
464
427
 
465
428
  ```graphql
466
- """A field's scalar, validation, and options differences."""
429
+ """A field whose properties, validation, condition or options differ."""
467
430
  type FieldDiffEntry {
468
- """Field id (stable across snapshots)."""
431
+ """The ID of the field."""
469
432
  id: ID!
470
- """Display name of the field, sourced from the compare snapshot."""
433
+ """Its name in the compare snapshot."""
471
434
  name: String!
472
- """Stable, human-readable key, sourced from the compare snapshot."""
435
+ """Its key in the compare snapshot."""
473
436
  key: String!
474
- """Scalar property changes."""
437
+ """The properties that differ."""
475
438
  propertyChanges: [PropertyChange!]!
476
- """Validation subtree change, or null when unchanged."""
439
+ """How the validation differs. Null when it is the same."""
477
440
  validationChange: LogicChange
478
- """Visibility-condition subtree change, or null when unchanged."""
441
+ """How the visibility condition differs. Null when it is the same."""
479
442
  conditionChange: LogicChange
480
- """Options-set change, or null when unchanged."""
443
+ """How the options differ. Null when they are the same."""
481
444
  optionsChange: FieldOptionsChange
482
445
  }
483
446
  ```
@@ -485,13 +448,13 @@ type FieldDiffEntry {
485
448
  ### `FieldDiff`
486
449
 
487
450
  ```graphql
488
- """Field section of the workspace diff."""
451
+ """The fields that differ between two snapshots."""
489
452
  type FieldDiff {
490
453
  """Fields present only in the compare snapshot."""
491
454
  added: [JSON!]!
492
455
  """Fields present only in the base snapshot."""
493
456
  removed: [JSON!]!
494
- """Fields present in both snapshots but with differing properties."""
457
+ """Fields present in both snapshots, with differing properties."""
495
458
  modified: [FieldDiffEntry!]!
496
459
  }
497
460
  ```
@@ -499,15 +462,15 @@ type FieldDiff {
499
462
  ### `ActionDiffEntry`
500
463
 
501
464
  ```graphql
502
- """An action's scalar property differences."""
465
+ """An action whose properties differ."""
503
466
  type ActionDiffEntry {
504
- """Action id (stable across snapshots)."""
467
+ """The ID of the action."""
505
468
  id: ID!
506
- """Display name of the action, sourced from the compare snapshot."""
469
+ """Its name in the compare snapshot."""
507
470
  name: String!
508
- """Stable, human-readable key, sourced from the compare snapshot."""
471
+ """Its key in the compare snapshot."""
509
472
  key: String!
510
- """Scalar property changes."""
473
+ """The properties that differ."""
511
474
  propertyChanges: [PropertyChange!]!
512
475
  }
513
476
  ```
@@ -515,13 +478,13 @@ type ActionDiffEntry {
515
478
  ### `ActionDiff`
516
479
 
517
480
  ```graphql
518
- """Action section of the workspace diff."""
481
+ """The actions that differ between two snapshots."""
519
482
  type ActionDiff {
520
483
  """Actions present only in the compare snapshot."""
521
484
  added: [JSON!]!
522
485
  """Actions present only in the base snapshot."""
523
486
  removed: [JSON!]!
524
- """Actions present in both snapshots but with differing properties."""
487
+ """Actions present in both snapshots, with differing properties."""
525
488
  modified: [ActionDiffEntry!]!
526
489
  }
527
490
  ```
@@ -529,17 +492,17 @@ type ActionDiff {
529
492
  ### `ConditionDiffEntry`
530
493
 
531
494
  ```graphql
532
- """A condition's scalar and logic differences."""
495
+ """A condition whose properties or logic differ."""
533
496
  type ConditionDiffEntry {
534
- """Condition id (stable across snapshots)."""
497
+ """The ID of the condition."""
535
498
  id: ID!
536
- """Display name of the condition, sourced from the compare snapshot."""
499
+ """Its name in the compare snapshot."""
537
500
  name: String!
538
- """Stable, human-readable key, sourced from the compare snapshot."""
501
+ """Its key in the compare snapshot."""
539
502
  key: String!
540
- """Scalar property changes."""
503
+ """The properties that differ."""
541
504
  propertyChanges: [PropertyChange!]!
542
- """Logic subtree change, or null when unchanged."""
505
+ """How the logic differs. Null when it is the same."""
543
506
  logicChange: LogicChange
544
507
  }
545
508
  ```
@@ -547,13 +510,13 @@ type ConditionDiffEntry {
547
510
  ### `ConditionDiff`
548
511
 
549
512
  ```graphql
550
- """Condition section of the workspace diff."""
513
+ """The conditions that differ between two snapshots."""
551
514
  type ConditionDiff {
552
515
  """Conditions present only in the compare snapshot."""
553
516
  added: [JSON!]!
554
517
  """Conditions present only in the base snapshot."""
555
518
  removed: [JSON!]!
556
- """Conditions present in both snapshots but with differing properties."""
519
+ """Conditions present in both snapshots, with differing properties."""
557
520
  modified: [ConditionDiffEntry!]!
558
521
  }
559
522
  ```
@@ -561,19 +524,19 @@ type ConditionDiff {
561
524
  ### `ExperienceDiffEntry`
562
525
 
563
526
  ```graphql
564
- """An experience's scalar property, target, and flow differences."""
527
+ """An experience whose properties, targeting or flow differ."""
565
528
  type ExperienceDiffEntry {
566
- """Experience id (stable across snapshots)."""
529
+ """The ID of the experience."""
567
530
  id: ID!
568
- """Display name of the experience, sourced from the compare snapshot."""
531
+ """Its name in the compare snapshot."""
569
532
  name: String!
570
- """Stable, human-readable key, sourced from the compare snapshot."""
533
+ """Its key in the compare snapshot."""
571
534
  key: String!
572
- """Scalar property changes."""
535
+ """The properties that differ."""
573
536
  propertyChanges: [PropertyChange!]!
574
- """Targeting change, or null when unchanged."""
537
+ """How the targeting differs. Null when it is the same."""
575
538
  targetChange: LogicChange
576
- """Flow change, or null when unchanged."""
539
+ """How the flow differs. Null when it is the same."""
577
540
  flowChange: ExperienceFlowChange
578
541
  }
579
542
  ```
@@ -581,13 +544,13 @@ type ExperienceDiffEntry {
581
544
  ### `ExperienceDiff`
582
545
 
583
546
  ```graphql
584
- """Experience section of the workspace diff."""
547
+ """The experiences that differ between two snapshots."""
585
548
  type ExperienceDiff {
586
549
  """Experiences present only in the compare snapshot."""
587
550
  added: [JSON!]!
588
551
  """Experiences present only in the base snapshot."""
589
552
  removed: [JSON!]!
590
- """Experiences present in both snapshots but with differing properties."""
553
+ """Experiences present in both snapshots, with differing properties."""
591
554
  modified: [ExperienceDiffEntry!]!
592
555
  }
593
556
  ```
@@ -595,15 +558,15 @@ type ExperienceDiff {
595
558
  ### `ContentModelDiffEntry`
596
559
 
597
560
  ```graphql
598
- """A Content Model's scalar and schema differences."""
561
+ """A Content Model whose properties or schema differ."""
599
562
  type ContentModelDiffEntry {
600
- """Content Model id (stable across snapshots)."""
563
+ """The ID of the Content Model."""
601
564
  id: ID!
602
- """Display name, sourced from the compare snapshot."""
565
+ """Its name in the compare snapshot."""
603
566
  name: String!
604
- """Scalar property changes."""
567
+ """The properties that differ."""
605
568
  propertyChanges: [PropertyChange!]!
606
- """Schema subtree change, or null when unchanged."""
569
+ """How the schema differs. Null when it is the same."""
607
570
  schemaChange: LogicChange
608
571
  }
609
572
  ```
@@ -611,15 +574,13 @@ type ContentModelDiffEntry {
611
574
  ### `ContentModelDiff`
612
575
 
613
576
  ```graphql
614
- """Content Model section of the workspace diff."""
577
+ """The Content Models that differ between two snapshots."""
615
578
  type ContentModelDiff {
616
579
  """Content Models present only in the compare snapshot."""
617
580
  added: [JSON!]!
618
581
  """Content Models present only in the base snapshot."""
619
582
  removed: [JSON!]!
620
- """
621
- Content Models present in both snapshots but with differing properties.
622
- """
583
+ """Content Models present in both snapshots, with differing properties."""
623
584
  modified: [ContentModelDiffEntry!]!
624
585
  }
625
586
  ```
@@ -627,15 +588,15 @@ type ContentModelDiff {
627
588
  ### `ContentBlockDiffEntry`
628
589
 
629
590
  ```graphql
630
- """A Content Block's scalar and schema differences."""
591
+ """A Content Block whose properties or schema differ."""
631
592
  type ContentBlockDiffEntry {
632
- """Content Block id (stable across snapshots)."""
593
+ """The ID of the Content Block."""
633
594
  id: ID!
634
- """Display name, sourced from the compare snapshot."""
595
+ """Its name in the compare snapshot."""
635
596
  name: String!
636
- """Scalar property changes."""
597
+ """The properties that differ."""
637
598
  propertyChanges: [PropertyChange!]!
638
- """Schema subtree change, or null when unchanged."""
599
+ """How the schema differs. Null when it is the same."""
639
600
  schemaChange: LogicChange
640
601
  }
641
602
  ```
@@ -643,15 +604,13 @@ type ContentBlockDiffEntry {
643
604
  ### `ContentBlockDiff`
644
605
 
645
606
  ```graphql
646
- """Content Block section of the workspace diff."""
607
+ """The Content Blocks that differ between two snapshots."""
647
608
  type ContentBlockDiff {
648
609
  """Content Blocks present only in the compare snapshot."""
649
610
  added: [JSON!]!
650
611
  """Content Blocks present only in the base snapshot."""
651
612
  removed: [JSON!]!
652
- """
653
- Content Blocks present in both snapshots but with differing properties.
654
- """
613
+ """Content Blocks present in both snapshots, with differing properties."""
655
614
  modified: [ContentBlockDiffEntry!]!
656
615
  }
657
616
  ```
@@ -659,15 +618,15 @@ type ContentBlockDiff {
659
618
  ### `ContentEntryDiffEntry`
660
619
 
661
620
  ```graphql
662
- """A Content Entry's scalar and data differences."""
621
+ """A content entry whose properties or data differ."""
663
622
  type ContentEntryDiffEntry {
664
- """Content Entry id (stable across snapshots)."""
623
+ """The ID of the content entry."""
665
624
  id: ID!
666
- """Parent Content Model id, sourced from the compare snapshot."""
625
+ """The ID of its Content Model in the compare snapshot."""
667
626
  contentModelId: ID!
668
- """Scalar property changes."""
627
+ """The properties that differ."""
669
628
  propertyChanges: [PropertyChange!]!
670
- """Data subtree change, or null when unchanged."""
629
+ """How the data differs. Null when it is the same."""
671
630
  dataChange: LogicChange
672
631
  }
673
632
  ```
@@ -675,15 +634,13 @@ type ContentEntryDiffEntry {
675
634
  ### `ContentEntryDiff`
676
635
 
677
636
  ```graphql
678
- """Content Entry section of the workspace diff."""
637
+ """The content entries that differ between two snapshots."""
679
638
  type ContentEntryDiff {
680
- """Content Entries present only in the compare snapshot."""
639
+ """Content entries present only in the compare snapshot."""
681
640
  added: [JSON!]!
682
- """Content Entries present only in the base snapshot."""
641
+ """Content entries present only in the base snapshot."""
683
642
  removed: [JSON!]!
684
- """
685
- Content Entries present in both snapshots but with differing properties.
686
- """
643
+ """Content entries present in both snapshots, with differing properties."""
687
644
  modified: [ContentEntryDiffEntry!]!
688
645
  }
689
646
  ```
@@ -692,22 +649,21 @@ type ContentEntryDiff {
692
649
 
693
650
  ```graphql
694
651
  """
695
- A workflow's trigger as the diff reports it. The action an `ACTION` trigger
696
- names is resolved against the snapshot the workflow belongs to, so a removed
697
- workflow still shows the action it was bound to.
652
+ A workflow's trigger, as a diff reports it. An `ACTION` trigger's action is read from the
653
+ workflow's own snapshot, so a removed workflow still shows its action.
698
654
  """
699
655
  type WorkflowDiffTrigger {
700
- """Which kind of trigger this is."""
656
+ """The kind of trigger."""
701
657
  type: WorkflowTriggerType!
702
658
  """The event that starts the run. Set for an `EVENT` trigger only."""
703
659
  eventName: WorkflowEventName
704
660
  """
705
- ID of the action whose run starts the workflow. Set for an `ACTION` trigger only.
661
+ The ID of the action whose run starts the workflow. Set for an `ACTION` trigger only.
706
662
  """
707
663
  actionId: ID
708
664
  """
709
- The action `actionId` names, resolved from the snapshot. Null for an
710
- `EVENT` trigger, and for an `ACTION` trigger whose action neither snapshot holds.
665
+ The action `actionId` names. Null for an `EVENT` trigger, and for an `ACTION` trigger whose
666
+ action neither snapshot holds.
711
667
  """
712
668
  action: DiffActionRef
713
669
  }
@@ -716,12 +672,12 @@ type WorkflowDiffTrigger {
716
672
  ### `WorkflowDiffNodeRef`
717
673
 
718
674
  ```graphql
719
- """A node in a workflow graph, summarised for the diff."""
675
+ """A node in a workflow graph, as a diff lists it."""
720
676
  type WorkflowDiffNodeRef {
721
- """Graph-unique node id, stable across snapshots of the same workflow."""
677
+ """The ID of the node, unique in its graph."""
722
678
  id: ID!
723
679
  """
724
- The node kind as stored: `ORIGIN`, `TOOL`, `CONDITION` or `SLEEP`; `UNKNOWN` when missing.
680
+ The node's kind: `ORIGIN`, `TOOL`, `CONDITION` or `SLEEP`, or `UNKNOWN` when it has none.
725
681
  """
726
682
  type: String!
727
683
  """
@@ -735,26 +691,26 @@ type WorkflowDiffNodeRef {
735
691
 
736
692
  ```graphql
737
693
  """
738
- How a workflow's graph changed between two snapshots. Nodes are matched by
739
- id; a node's canvas position is layout and never makes it a modified node.
694
+ How a workflow's graph differs between two snapshots. Nodes are matched by ID; moving a node on the
695
+ canvas never makes it a modified node.
740
696
  """
741
697
  type WorkflowGraphChange {
742
- """Number of nodes in the base snapshot's graph."""
698
+ """The number of nodes in the base snapshot's graph."""
743
699
  baseNodeCount: Int!
744
- """Number of nodes in the compare snapshot's graph."""
700
+ """The number of nodes in the compare snapshot's graph."""
745
701
  compareNodeCount: Int!
746
- """Number of edges in the base snapshot's graph."""
702
+ """The number of edges in the base snapshot's graph."""
747
703
  baseEdgeCount: Int!
748
- """Number of edges in the compare snapshot's graph."""
704
+ """The number of edges in the compare snapshot's graph."""
749
705
  compareEdgeCount: Int!
750
706
  """Nodes present only in the compare snapshot."""
751
707
  addedNodes: [WorkflowDiffNodeRef!]!
752
708
  """Nodes present only in the base snapshot."""
753
709
  removedNodes: [WorkflowDiffNodeRef!]!
754
- """Nodes present in both snapshots whose configuration differs."""
710
+ """Nodes present in both snapshots, with differing configuration."""
755
711
  modifiedNodes: [WorkflowDiffNodeRef!]!
756
712
  """
757
- True iff the graph differs with no node added, removed or reconfigured: edges were rewired, or nodes moved.
713
+ Whether the graph differs with no node added, removed or reconfigured: edges were rewired, or nodes moved.
758
714
  """
759
715
  structureChanged: Boolean!
760
716
  }
@@ -763,19 +719,17 @@ type WorkflowGraphChange {
763
719
  ### `WorkflowDiffSummary`
764
720
 
765
721
  ```graphql
766
- """
767
- A workflow as the diff lists it when it is present in one snapshot only.
768
- """
722
+ """A workflow present in one snapshot only."""
769
723
  type WorkflowDiffSummary {
770
- """Workflow id (stable across snapshots)."""
724
+ """The ID of the workflow."""
771
725
  id: ID!
772
- """Display name of the workflow."""
726
+ """The workflow's name."""
773
727
  name: String!
774
- """The trigger, or null when the stored trigger cannot be read."""
728
+ """The trigger. Null when it cannot be read."""
775
729
  trigger: WorkflowDiffTrigger
776
- """Number of nodes in the workflow's graph."""
730
+ """The number of nodes in the workflow's graph."""
777
731
  nodeCount: Int!
778
- """Number of edges in the workflow's graph."""
732
+ """The number of edges in the workflow's graph."""
779
733
  edgeCount: Int!
780
734
  }
781
735
  ```
@@ -783,21 +737,19 @@ type WorkflowDiffSummary {
783
737
  ### `WorkflowDiffEntry`
784
738
 
785
739
  ```graphql
786
- """A workflow's scalar, trigger and graph differences."""
740
+ """A workflow whose properties, trigger or graph differ."""
787
741
  type WorkflowDiffEntry {
788
- """Workflow id (stable across snapshots)."""
742
+ """The ID of the workflow."""
789
743
  id: ID!
790
- """Display name of the workflow, sourced from the compare snapshot."""
744
+ """Its name in the compare snapshot."""
791
745
  name: String!
792
- """
793
- The compare snapshot's trigger, or null when the stored trigger cannot be read.
794
- """
746
+ """The trigger in the compare snapshot. Null when it cannot be read."""
795
747
  trigger: WorkflowDiffTrigger
796
- """Scalar property changes."""
748
+ """The properties that differ."""
797
749
  propertyChanges: [PropertyChange!]!
798
- """Trigger subtree change, or null when unchanged."""
750
+ """How the trigger differs. Null when it is the same."""
799
751
  triggerChange: LogicChange
800
- """Graph change, or null when unchanged."""
752
+ """How the graph differs. Null when it is the same."""
801
753
  graphChange: WorkflowGraphChange
802
754
  }
803
755
  ```
@@ -806,9 +758,8 @@ type WorkflowDiffEntry {
806
758
 
807
759
  ```graphql
808
760
  """
809
- Workflow section of the workspace diff. Workflows are frozen onto a version
810
- by `workspacePublish`, so a live workspace's workflows are compared against
811
- the copies the version froze.
761
+ The workflows that differ between two snapshots. A version's workflows are the copies frozen when
762
+ it was published.
812
763
  """
813
764
  type WorkflowDiff {
814
765
  """Workflows present only in the compare snapshot."""
@@ -816,7 +767,7 @@ type WorkflowDiff {
816
767
  """Workflows present only in the base snapshot."""
817
768
  removed: [WorkflowDiffSummary!]!
818
769
  """
819
- Workflows present in both snapshots but with differing properties, trigger or graph.
770
+ Workflows present in both snapshots, with differing properties, trigger or graph.
820
771
  """
821
772
  modified: [WorkflowDiffEntry!]!
822
773
  }