Skip to content

Commit 3065ef5

Browse files
shahednassershahednasser
committed
fixes
1 parent bcaf202 commit 3065ef5

26 files changed

Lines changed: 82 additions & 322 deletions

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_translations_settings_batch/post.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,4 @@ sdk.admin.translation.batchSettings({
2727
})
2828
.then(({ created, updated, deleted }) => {
2929
console.log(created, updated, deleted)
30-
})
31-
```
30+
})

‎www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ properties:
8585
created_by:
8686
type: string
8787
title: created_by
88-
description: The fulfillment's created by.
88+
description: The ID of the user that created the fulfillment.
8989
marked_shipped_by:
9090
type: string
9191
title: marked_shipped_by
92-
description: The fulfillment's marked shipped by.
92+
description: The ID of the user that marked the fulfillment as shipped.

‎www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ properties:
8080
created_by:
8181
type: string
8282
title: created_by
83-
description: The return's created by.
83+
description: The ID of the user that created the return.

‎www/apps/api-reference/specs/admin/components/schemas/AdminTranslationEntitiesResponse.yaml‎

Lines changed: 4 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -13,68 +13,20 @@ properties:
1313
items:
1414
allOf:
1515
- type: object
16-
description: The datum's data.
17-
- type: object
18-
description: The datum's data.
16+
description: The entity's data.
1917
required:
2018
- id
2119
- translations
2220
properties:
2321
id:
2422
type: string
2523
title: id
26-
description: The datum's ID.
24+
description: The entity's ID.
2725
translations:
2826
type: array
29-
description: The datum's translations.
27+
description: The entity's translations.
3028
items:
31-
type: object
32-
description: The translation's translations.
33-
x-schemaName: AdminTranslation
34-
required:
35-
- id
36-
- reference_id
37-
- reference
38-
- locale_code
39-
- translations
40-
- created_at
41-
- updated_at
42-
- deleted_at
43-
properties:
44-
id:
45-
type: string
46-
title: id
47-
description: The translation's ID.
48-
reference_id:
49-
type: string
50-
title: reference_id
51-
description: The translation's reference id.
52-
reference:
53-
type: string
54-
title: reference
55-
description: The translation's reference.
56-
locale_code:
57-
type: string
58-
title: locale_code
59-
description: The translation's locale code.
60-
translations:
61-
type: object
62-
description: The translation's translations.
63-
created_at:
64-
type: string
65-
format: date-time
66-
title: created_at
67-
description: The translation's created at.
68-
updated_at:
69-
type: string
70-
format: date-time
71-
title: updated_at
72-
description: The translation's updated at.
73-
deleted_at:
74-
type: string
75-
format: date-time
76-
title: deleted_at
77-
description: The translation's deleted at.
29+
$ref: ./AdminTranslation.yaml
7830
count:
7931
type: number
8032
title: count

‎www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ properties:
8585
created_by:
8686
type: string
8787
title: created_by
88-
description: The fulfillment's created by.
88+
description: The ID of the user that created the fulfillment.
8989
marked_shipped_by:
9090
type: string
9191
title: marked_shipped_by
92-
description: The fulfillment's marked shipped by.
92+
description: The ID of the user that marked the fulfillment as shipped.

‎www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ properties:
8585
created_by:
8686
type: string
8787
title: created_by
88-
description: The fulfillment's created by.
88+
description: The ID of the user that created the fulfillment.
8989
marked_shipped_by:
9090
type: string
9191
title: marked_shipped_by
92-
description: The fulfillment's marked shipped by.
92+
description: The ID of the user that marked the fulfillment as shipped.

‎www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ properties:
6969
created_by:
7070
type: string
7171
title: created_by
72-
description: The return's created by.
72+
description: The ID of the user that created the return.

‎www/apps/api-reference/specs/admin/openapi.full.yaml‎

Lines changed: 19 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -25502,11 +25502,12 @@ paths:
2550225502
description: The invite's metadata. Can be custom data in key-value pairs.
2550325503
roles:
2550425504
type: array
25505-
description: The invite's roles.
25505+
description: The invited user's roles.
25506+
x-featureFlag: rbac
2550625507
items:
2550725508
type: string
2550825509
title: roles
25509-
description: The role's roles.
25510+
description: The invited user's role.
2551025511
x-codeSamples:
2551125512
- lang: JavaScript
2551225513
label: JS SDK
@@ -64157,7 +64158,6 @@ paths:
6415764158
.then(({ created, updated, deleted }) => {
6415864159
console.log(created, updated, deleted)
6415964160
})
64160-
```
6416164161
- lang: Shell
6416264162
label: cURL
6416364163
source: |-
@@ -66377,16 +66377,16 @@ paths:
6637766377
oneOf:
6637866378
- type: string
6637966379
title: state
66380-
description: The workflows execution's state.
66380+
description: Filter by a workflow execution's state.
6638166381
- type: array
66382-
description: The workflows execution's state.
66382+
description: Filter by workflow execution states.
6638366383
items:
6638466384
type: string
6638566385
title: state
66386-
description: The state's details.
66386+
description: A workflow execution state.
6638766387
- name: created_at
6638866388
in: query
66389-
description: The workflows execution's created at.
66389+
description: Filter by the workflow execution's creation date.
6639066390
required: false
6639166391
schema:
6639266392
type: object
@@ -75711,11 +75711,11 @@ components:
7571175711
created_by:
7571275712
type: string
7571375713
title: created_by
75714-
description: The fulfillment's created by.
75714+
description: The ID of the user that created the fulfillment.
7571575715
marked_shipped_by:
7571675716
type: string
7571775717
title: marked_shipped_by
75718-
description: The fulfillment's marked shipped by.
75718+
description: The ID of the user that marked the fulfillment as shipped.
7571975719
AdminOrderItem:
7572075720
type: object
7572175721
description: The order item's details.
@@ -79537,7 +79537,7 @@ components:
7953779537
created_by:
7953879538
type: string
7953979539
title: created_by
79540-
description: The return's created by.
79540+
description: The ID of the user that created the return.
7954179541
AdminReturnItem:
7954279542
type: object
7954379543
description: The return item's details.
@@ -81356,68 +81356,20 @@ components:
8135681356
items:
8135781357
allOf:
8135881358
- type: object
81359-
description: The datum's data.
81360-
- type: object
81361-
description: The datum's data.
81359+
description: The entity's data.
8136281360
required:
8136381361
- id
8136481362
- translations
8136581363
properties:
8136681364
id:
8136781365
type: string
8136881366
title: id
81369-
description: The datum's ID.
81367+
description: The entity's ID.
8137081368
translations:
8137181369
type: array
81372-
description: The datum's translations.
81370+
description: The entity's translations.
8137381371
items:
81374-
type: object
81375-
description: The translation's translations.
81376-
x-schemaName: AdminTranslation
81377-
required:
81378-
- id
81379-
- reference_id
81380-
- reference
81381-
- locale_code
81382-
- translations
81383-
- created_at
81384-
- updated_at
81385-
- deleted_at
81386-
properties:
81387-
id:
81388-
type: string
81389-
title: id
81390-
description: The translation's ID.
81391-
reference_id:
81392-
type: string
81393-
title: reference_id
81394-
description: The translation's reference id.
81395-
reference:
81396-
type: string
81397-
title: reference
81398-
description: The translation's reference.
81399-
locale_code:
81400-
type: string
81401-
title: locale_code
81402-
description: The translation's locale code.
81403-
translations:
81404-
type: object
81405-
description: The translation's translations.
81406-
created_at:
81407-
type: string
81408-
format: date-time
81409-
title: created_at
81410-
description: The translation's created at.
81411-
updated_at:
81412-
type: string
81413-
format: date-time
81414-
title: updated_at
81415-
description: The translation's updated at.
81416-
deleted_at:
81417-
type: string
81418-
format: date-time
81419-
title: deleted_at
81420-
description: The translation's deleted at.
81372+
$ref: '#/components/schemas/AdminTranslation'
8142181373
count:
8142281374
type: number
8142381375
title: count
@@ -85232,11 +85184,11 @@ components:
8523285184
created_by:
8523385185
type: string
8523485186
title: created_by
85235-
description: The fulfillment's created by.
85187+
description: The ID of the user that created the fulfillment.
8523685188
marked_shipped_by:
8523785189
type: string
8523885190
title: marked_shipped_by
85239-
description: The fulfillment's marked shipped by.
85191+
description: The ID of the user that marked the fulfillment as shipped.
8524085192
BaseOrderItemDetail:
8524185193
type: object
8524285194
description: The item's detail.
@@ -92013,11 +91965,11 @@ components:
9201391965
created_by:
9201491966
type: string
9201591967
title: created_by
92016-
description: The fulfillment's created by.
91968+
description: The ID of the user that created the fulfillment.
9201791969
marked_shipped_by:
9201891970
type: string
9201991971
title: marked_shipped_by
92020-
description: The fulfillment's marked shipped by.
91972+
description: The ID of the user that marked the fulfillment as shipped.
9202191973
StoreOrderLineItem:
9202291974
type: object
9202391975
description: The item's details.
@@ -99012,7 +98964,7 @@ components:
9901298964
created_by:
9901398965
type: string
9901498966
title: created_by
99015-
description: The return's created by.
98967+
description: The ID of the user that created the return.
9901698968
StoreReturnItem:
9901798969
type: object
9901898970
description: The return item's details.

‎www/apps/api-reference/specs/admin/paths/admin_invites.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -651,11 +651,12 @@ post:
651651
description: The invite's metadata. Can be custom data in key-value pairs.
652652
roles:
653653
type: array
654-
description: The invite's roles.
654+
description: The invited user's roles.
655+
x-featureFlag: rbac
655656
items:
656657
type: string
657658
title: roles
658-
description: The role's roles.
659+
description: The invited user's role.
659660
x-codeSamples:
660661
- lang: JavaScript
661662
label: JS SDK

‎www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,16 @@ get:
109109
oneOf:
110110
- type: string
111111
title: state
112-
description: The workflows execution's state.
112+
description: Filter by a workflow execution's state.
113113
- type: array
114-
description: The workflows execution's state.
114+
description: Filter by workflow execution states.
115115
items:
116116
type: string
117117
title: state
118-
description: The state's details.
118+
description: A workflow execution state.
119119
- name: created_at
120120
in: query
121-
description: The workflows execution's created at.
121+
description: Filter by the workflow execution's creation date.
122122
required: false
123123
schema:
124124
type: object

0 commit comments

Comments
 (0)