Skip to content

Commit 5905ebe

Browse files
committed
fixes
1 parent 64c7fd8 commit 5905ebe

82 files changed

Lines changed: 852 additions & 732 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
type: object
2-
description: SUMMARY
2+
description: The details for authorizing a payment session for an order.
33
x-schemaName: AdminAuthorizeOrderPaymentSession
44
required:
55
- payment_session_id
66
properties:
77
payment_session_id:
88
type: string
99
title: payment_session_id
10-
description: The order's payment session id.
10+
description: The payment session's ID.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: SUMMARY
2+
description: The details of the response after authorizing a payment session for an order.
33
x-schemaName: AdminAuthorizeOrderPaymentSessionResponse
44
required:
55
- order
@@ -10,4 +10,4 @@ properties:
1010
is_authorized:
1111
type: boolean
1212
title: is_authorized
13-
description: The order's is authorized.
13+
description: Whether the payment session was successfully authorized.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ properties:
5050
description: The date the invite was updated.
5151
rbac_roles:
5252
type: array
53-
description: The invite's rbac roles.
53+
description: The roles of the invited user.
54+
x-featureFlag: rbac
5455
items:
5556
$ref: ./AdminRbacRole.yaml

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: The layout configuration's layout configurations.
2+
description: The layout configuration's details.
33
x-schemaName: AdminLayoutConfiguration
44
required:
55
- id
@@ -21,31 +21,34 @@ properties:
2121
user_id:
2222
type: string
2323
title: user_id
24-
description: The layout configuration's user id.
24+
description: The ID of the user who created the layout configuration.
2525
is_system_default:
2626
type: boolean
2727
title: is_system_default
28-
description: The layout configuration's is system default.
28+
description: Whether the layout configuration is a system default.
2929
configuration:
3030
type: object
31-
description: The layout configuration's configuration.
31+
description: The configuration's details.
3232
required:
3333
- widgets
3434
properties:
3535
widgets:
3636
type: object
37-
description: The configuration's widgets.
37+
description: >-
38+
The configurations of the widgets in the layout. The object's keys are
39+
the widget IDs, and the values are objects containing the widget's
40+
configuration details.
3841
additionalProperties:
3942
type: object
4043
properties:
4144
hidden:
4245
type: boolean
4346
title: hidden
44-
description: The widget's hidden.
47+
description: Whether the widget is hidden.
4548
section:
4649
type: string
4750
title: section
48-
description: The widget's section.
51+
description: The section of the layout where the widget is placed.
4952
order:
5053
type: number
5154
title: order
@@ -54,9 +57,9 @@ properties:
5457
type: string
5558
format: date-time
5659
title: created_at
57-
description: The layout configuration's created at.
60+
description: The date the layout configuration was created.
5861
updated_at:
5962
type: string
6063
format: date-time
6164
title: updated_at
62-
description: The layout configuration's updated at.
65+
description: The date the layout configuration was last updated.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: SUMMARY
2+
description: The details for a layout configuration response.
33
x-schemaName: AdminLayoutConfigurationResponse
44
required:
55
- personal_configuration
@@ -12,7 +12,7 @@ properties:
1212
$ref: ./AdminLayoutConfiguration.yaml
1313
active_scope:
1414
type: string
15-
description: The layout's active scope.
15+
description: The active scope of the layout configuration.
1616
enum:
1717
- default
1818
- personal
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: The add's details.
2+
description: The details for linking a product option with its values.
33
x-schemaName: AdminLinkProductOptionWithValues
44
required:
55
- id
@@ -8,11 +8,11 @@ properties:
88
id:
99
type: string
1010
title: id
11-
description: The add's ID.
11+
description: The option's ID.
1212
value_ids:
1313
type: array
14-
description: The add's value ids.
14+
description: The values to add to the product.
1515
items:
1616
type: string
1717
title: value_ids
18-
description: The value id's value ids.
18+
description: The value's ID.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
type: object
2-
description: SUMMARY
2+
description: The details of linking product options to a product.
33
x-schemaName: AdminLinkProductOptions
44
properties:
55
add:
66
type: array
7-
description: The product's add.
7+
description: The options to add to the product.
88
items:
99
oneOf:
1010
- type: string
1111
title: add
12-
description: The add's details.
12+
description: The details of the product option to add.
1313
- $ref: ./AdminCreateProductOption.yaml
1414
- $ref: ./AdminLinkProductOptionWithValues.yaml
1515
remove:
1616
type: array
17-
description: The product's remove.
17+
description: The IDs of the product options to remove from the product.
1818
items:
1919
type: string
2020
title: remove
21-
description: The remove's details.
21+
description: The ID of the product option to remove.
2222
update:
2323
type: array
2424
description: The product's update.
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: SUMMARY
2+
description: The details of the product option value deletion.
33
x-schemaName: AdminProductOptionValueDeleteResponse
44
required:
55
- id
@@ -9,14 +9,15 @@ properties:
99
id:
1010
type: string
1111
title: id
12-
description: The product option's ID.
12+
description: The ID of the deleted product option value.
1313
object:
1414
type: string
1515
title: object
1616
description: The name of the deleted object.
17+
default: product_option_value
1718
deleted:
1819
type: boolean
1920
title: deleted
20-
description: Whether the Product Option was deleted.
21+
description: Whether the Product Option Value was deleted.
2122
parent:
2223
$ref: ./AdminProductOption.yaml

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: SUMMARY
2+
description: The details of a product option value.
33
x-schemaName: AdminProductOptionValueResponse
44
required:
55
- product_option_value

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

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: The policy's policies.
2+
description: The details of an RBAC policy.
33
x-schemaName: AdminRbacPolicy
44
required:
55
- id
@@ -24,38 +24,40 @@ properties:
2424
resource:
2525
type: string
2626
title: resource
27-
description: The policy's resource.
27+
description: The resource that the policy applies to.
28+
example: product
2829
operation:
2930
type: string
3031
title: operation
31-
description: The policy's operation.
32+
description: The operation that the policy allows or denies.
33+
example: create
3234
name:
3335
type: string
3436
title: name
35-
description: The policy's name.
37+
description: The policy's name. Used for display purposes.
3638
description:
3739
type: string
3840
title: description
3941
description: The policy's description.
4042
metadata:
4143
type: object
42-
description: The policy's metadata.
44+
description: Key-value pairs that hold additional information about the policy.
4345
inherited_from_role_id:
4446
type: string
4547
title: inherited_from_role_id
46-
description: The policy's inherited from role id.
48+
description: The ID of the role from which the policy is inherited.
4749
created_at:
4850
type: string
4951
format: date-time
5052
title: created_at
51-
description: The policy's created at.
53+
description: The date the policy was created.
5254
updated_at:
5355
type: string
5456
format: date-time
5557
title: updated_at
56-
description: The policy's updated at.
58+
description: The date the policy was last updated.
5759
deleted_at:
5860
type: string
5961
format: date-time
6062
title: deleted_at
61-
description: The policy's deleted at.
63+
description: The date the policy was deleted.

0 commit comments

Comments
 (0)