From f089002c78bc023c5bf2835158a9771749dab03f Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 14 Oct 2024 13:45:05 +0300 Subject: [PATCH] fixes --- .../admin/components/schemas/AdminClaim.yaml | 6 +- .../schemas/AdminClaimOrderResponse.yaml | 6 +- .../schemas/AdminCreateShippingOption.yaml | 2 +- .../AdminCreateShippingOptionRule.yaml | 15 +- .../components/schemas/AdminExchange.yaml | 6 +- .../schemas/AdminExchangeOrderResponse.yaml | 7 +- .../schemas/AdminOrderPreviewResponse.yaml | 8 +- .../schemas/AdminOrderResponse.yaml | 6 +- .../schemas/AdminOrderReturnResponse.yaml | 6 +- ...minPostOrderEditsItemsActionReqSchema.yaml | 2 +- ...OrderEditsUpdateItemQuantityReqSchema.yaml | 2 +- .../components/schemas/AdminUpdateUser.yaml | 2 +- .../components/schemas/BaseProductImage.yaml | 30 +++ .../components/schemas/BaseProductOption.yaml | 41 ++++ .../schemas/BaseProductOptionValue.yaml | 36 ++++ .../schemas/StoreOrderResponse.yaml | 6 +- .../specs/admin/openapi.full.yaml | 179 +++++++++++++----- .../store/components/schemas/AdminClaim.yaml | 6 +- .../schemas/AdminClaimOrderResponse.yaml | 6 +- .../schemas/AdminCreateShippingOption.yaml | 2 +- .../AdminCreateShippingOptionRule.yaml | 15 +- .../components/schemas/AdminExchange.yaml | 6 +- .../schemas/AdminExchangeOrderResponse.yaml | 7 +- .../schemas/AdminOrderPreviewResponse.yaml | 8 +- .../schemas/AdminOrderResponse.yaml | 6 +- .../schemas/AdminOrderReturnResponse.yaml | 6 +- ...minPostOrderEditsItemsActionReqSchema.yaml | 2 +- ...OrderEditsUpdateItemQuantityReqSchema.yaml | 2 +- .../components/schemas/AdminUpdateUser.yaml | 2 +- .../components/schemas/BaseProductImage.yaml | 30 +++ .../components/schemas/BaseProductOption.yaml | 41 ++++ .../schemas/BaseProductOptionValue.yaml | 36 ++++ .../schemas/StoreOrderResponse.yaml | 6 +- .../specs/store/openapi.full.yaml | 179 +++++++++++++----- .../oas-output/schemas/AdminClaim.ts | 6 +- .../schemas/AdminClaimOrderResponse.ts | 6 +- .../schemas/AdminCreateShippingOption.ts | 2 +- .../schemas/AdminCreateShippingOptionRule.ts | 15 +- .../oas-output/schemas/AdminExchange.ts | 6 +- .../schemas/AdminExchangeOrderResponse.ts | 7 +- .../schemas/AdminOrderPreviewResponse.ts | 6 +- .../oas-output/schemas/AdminOrderResponse.ts | 6 +- .../schemas/AdminOrderReturnResponse.ts | 6 +- ...AdminPostOrderEditsItemsActionReqSchema.ts | 2 +- ...stOrderEditsUpdateItemQuantityReqSchema.ts | 2 +- .../oas-output/schemas/AdminUpdateUser.ts | 2 +- .../oas-output/schemas/BaseProductImage.ts | 30 +++ .../oas-output/schemas/BaseProductOption.ts | 41 ++++ .../schemas/BaseProductOptionValue.ts | 36 ++++ .../oas-output/schemas/StoreOrderResponse.ts | 6 +- 50 files changed, 645 insertions(+), 254 deletions(-) diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml index 4ff3436a82dcf..d6104bdcebdb2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml @@ -79,11 +79,7 @@ properties: title: updated_at description: The claim's update date. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml type: type: string description: The claim's type. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml index c00d10f0121a8..ea206926d5654 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml @@ -6,10 +6,6 @@ required: - claim properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./Order.yaml claim: $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml index 76e37a2dd8036..2477095764325 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping option's type. +description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - label diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml index 5fca721e07503..05df606241c91 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml @@ -1,5 +1,5 @@ type: object -description: The rule's rules. +description: The details of the shipping option rule. x-schemaName: AdminCreateShippingOptionRule required: - operator @@ -8,7 +8,7 @@ required: properties: operator: type: string - description: The rule's operator. + description: The operator used to check whether a rule applies. enum: - gt - lt @@ -21,15 +21,18 @@ properties: attribute: type: string title: attribute - description: The rule's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml index b24f1ff44b57a..31e20a4158f75 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -95,11 +95,7 @@ properties: title: deleted_at description: The date the exchange was deleted. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml allow_backorder: type: boolean title: allow_backorder diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml index 6dfe7e511aacd..03bc03d999ba2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml @@ -6,10 +6,7 @@ required: - exchange properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + description: The details of the associated order. + $ref: ./Order.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml index f0087ba36367c..f94371d50e7ba 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml @@ -5,10 +5,4 @@ required: - order properties: order: - type: string - title: order - description: >- - A preview of an order if a change, such as exchange, return, edit, or - claim is applied on it. - externalDocs: - url: '#pagination' + $ref: ./AdminOrderPreview.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml index 54adac5bae0a3..7dbac7fa46222 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml @@ -5,8 +5,4 @@ required: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml index f097f2ba85c33..ccc9891c960af 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml @@ -6,10 +6,6 @@ required: - return properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./Order.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index cf00b8425f94d..0d80349175377 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -13,4 +13,4 @@ properties: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index 34c1385f8155e..bf3acfba0e409 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -15,4 +15,4 @@ properties: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml index d890abd833c52..32e881a213587 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml @@ -16,4 +16,4 @@ properties: description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml index 95a4b0268dc43..f1e59ad937a5e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml @@ -1,3 +1,33 @@ type: object description: The image's details. x-schemaName: BaseProductImage +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. +required: + - id + - url diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml index a6a92e1cf4fbe..152999bb1ca54 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml @@ -1,3 +1,44 @@ type: object description: The product option's details. x-schemaName: BaseProductOption +properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: ./BaseProductOptionValue.yaml + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. +required: + - id + - title diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml index 0fe30515bbf4e..ba0a4dfd87809 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml @@ -1,3 +1,39 @@ type: object description: The product option value's details. x-schemaName: BaseProductOptionValue +required: + - id + - value +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml index 91432d40675e1..ee6f5a725ee02 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml @@ -5,8 +5,4 @@ required: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./StoreOrder.yaml diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 76c9631ea6cd9..f04edd266752d 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -45289,11 +45289,7 @@ components: title: updated_at description: The claim's update date. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' type: type: string description: The claim's type. @@ -45376,11 +45372,7 @@ components: - claim properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/Order' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimPreviewResponse: @@ -46498,7 +46490,7 @@ components: description: The label's URL. AdminCreateShippingOption: type: object - description: The shipping option's type. + description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - label @@ -46519,7 +46511,7 @@ components: description: The type's code. AdminCreateShippingOptionRule: type: object - description: The rule's rules. + description: The details of the shipping option rule. x-schemaName: AdminCreateShippingOptionRule required: - operator @@ -46528,7 +46520,7 @@ components: properties: operator: type: string - description: The rule's operator. + description: The operator used to check whether a rule applies. enum: - gt - lt @@ -46541,18 +46533,21 @@ components: attribute: type: string title: attribute - description: The rule's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 AdminCreateShippingProfile: type: object description: The shipping profile's details. @@ -47779,11 +47774,7 @@ components: title: deleted_at description: The date the exchange was deleted. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' allow_backorder: type: boolean title: allow_backorder @@ -47819,11 +47810,8 @@ components: - exchange properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + description: The details of the associated order. + $ref: '#/components/schemas/Order' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangePreviewResponse: @@ -50264,11 +50252,7 @@ components: - order properties: order: - type: string - title: order - description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrderPreview' AdminOrderResponse: type: object description: An order's details. @@ -50277,11 +50261,7 @@ components: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' AdminOrderReturnResponse: type: object description: The order return details. @@ -50291,11 +50271,7 @@ components: - return properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/Order' return: $ref: '#/components/schemas/AdminReturn' AdminOrderShippingMethod: @@ -51077,7 +51053,7 @@ components: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. AdminPostOrderEditsReqSchema: type: object description: The order edit's details. @@ -51160,7 +51136,7 @@ components: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. AdminPostOrderExchangesReqSchema: type: object description: The exchange's details. @@ -55184,7 +55160,7 @@ components: description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. AdminUpdateVariantInventoryItem: type: object description: The properties to update of the variant's inventory item association. @@ -58135,14 +58111,121 @@ components: type: object description: The image's details. x-schemaName: BaseProductImage + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. + required: + - id + - url BaseProductOption: type: object description: The product option's details. x-schemaName: BaseProductOption + properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. + required: + - id + - title BaseProductOptionValue: type: object description: The product option value's details. x-schemaName: BaseProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. BaseProductTag: type: object description: The tag's tags. @@ -63357,11 +63440,7 @@ components: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/StoreOrder' StorePaymentCollection: type: object description: The payment collection's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml index 4ff3436a82dcf..d6104bdcebdb2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml @@ -79,11 +79,7 @@ properties: title: updated_at description: The claim's update date. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml type: type: string description: The claim's type. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml index c00d10f0121a8..ea206926d5654 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml @@ -6,10 +6,6 @@ required: - claim properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./Order.yaml claim: $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml index 76e37a2dd8036..2477095764325 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping option's type. +description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - label diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml index 5fca721e07503..05df606241c91 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml @@ -1,5 +1,5 @@ type: object -description: The rule's rules. +description: The details of the shipping option rule. x-schemaName: AdminCreateShippingOptionRule required: - operator @@ -8,7 +8,7 @@ required: properties: operator: type: string - description: The rule's operator. + description: The operator used to check whether a rule applies. enum: - gt - lt @@ -21,15 +21,18 @@ properties: attribute: type: string title: attribute - description: The rule's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml index b24f1ff44b57a..31e20a4158f75 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -95,11 +95,7 @@ properties: title: deleted_at description: The date the exchange was deleted. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml allow_backorder: type: boolean title: allow_backorder diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml index 6dfe7e511aacd..03bc03d999ba2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml @@ -6,10 +6,7 @@ required: - exchange properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + description: The details of the associated order. + $ref: ./Order.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml index f0087ba36367c..f94371d50e7ba 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml @@ -5,10 +5,4 @@ required: - order properties: order: - type: string - title: order - description: >- - A preview of an order if a change, such as exchange, return, edit, or - claim is applied on it. - externalDocs: - url: '#pagination' + $ref: ./AdminOrderPreview.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml index 54adac5bae0a3..7dbac7fa46222 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml @@ -5,8 +5,4 @@ required: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml index f097f2ba85c33..ccc9891c960af 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml @@ -6,10 +6,6 @@ required: - return properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./Order.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index cf00b8425f94d..0d80349175377 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -13,4 +13,4 @@ properties: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index 34c1385f8155e..bf3acfba0e409 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -15,4 +15,4 @@ properties: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml index d890abd833c52..32e881a213587 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml @@ -16,4 +16,4 @@ properties: description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml index 95a4b0268dc43..f1e59ad937a5e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml @@ -1,3 +1,33 @@ type: object description: The image's details. x-schemaName: BaseProductImage +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. +required: + - id + - url diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml index a6a92e1cf4fbe..152999bb1ca54 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml @@ -1,3 +1,44 @@ type: object description: The product option's details. x-schemaName: BaseProductOption +properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: ./BaseProductOptionValue.yaml + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. +required: + - id + - title diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml index 0fe30515bbf4e..ba0a4dfd87809 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml @@ -1,3 +1,39 @@ type: object description: The product option value's details. x-schemaName: BaseProductOptionValue +required: + - id + - value +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml index 91432d40675e1..ee6f5a725ee02 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml @@ -5,8 +5,4 @@ required: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: ./StoreOrder.yaml diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 4ec5bde87342b..25ec9b80ea617 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -6877,11 +6877,7 @@ components: title: updated_at description: The claim's update date. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' type: type: string description: The claim's type. @@ -6964,11 +6960,7 @@ components: - claim properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/Order' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimPreviewResponse: @@ -8086,7 +8078,7 @@ components: description: The label's URL. AdminCreateShippingOption: type: object - description: The shipping option's type. + description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - label @@ -8107,7 +8099,7 @@ components: description: The type's code. AdminCreateShippingOptionRule: type: object - description: The rule's rules. + description: The details of the shipping option rule. x-schemaName: AdminCreateShippingOptionRule required: - operator @@ -8116,7 +8108,7 @@ components: properties: operator: type: string - description: The rule's operator. + description: The operator used to check whether a rule applies. enum: - gt - lt @@ -8129,18 +8121,21 @@ components: attribute: type: string title: attribute - description: The rule's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 AdminCreateShippingProfile: type: object description: The shipping profile's details. @@ -9367,11 +9362,7 @@ components: title: deleted_at description: The date the exchange was deleted. order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' allow_backorder: type: boolean title: allow_backorder @@ -9407,11 +9398,8 @@ components: - exchange properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + description: The details of the associated order. + $ref: '#/components/schemas/Order' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangePreviewResponse: @@ -11852,11 +11840,7 @@ components: - order properties: order: - type: string - title: order - description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrderPreview' AdminOrderResponse: type: object description: An order's details. @@ -11865,11 +11849,7 @@ components: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' AdminOrderReturnResponse: type: object description: The order return details. @@ -11879,11 +11859,7 @@ components: - return properties: order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/Order' return: $ref: '#/components/schemas/AdminReturn' AdminOrderShippingMethod: @@ -12665,7 +12641,7 @@ components: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. AdminPostOrderEditsReqSchema: type: object description: The order edit's details. @@ -12748,7 +12724,7 @@ components: unit_price: type: number title: unit_price - description: The order edit's unit price. + description: The item's unit price. AdminPostOrderExchangesReqSchema: type: object description: The exchange's details. @@ -16772,7 +16748,7 @@ components: description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. AdminUpdateVariantInventoryItem: type: object description: The properties to update of the variant's inventory item association. @@ -19723,14 +19699,121 @@ components: type: object description: The image's details. x-schemaName: BaseProductImage + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. + required: + - id + - url BaseProductOption: type: object description: The product option's details. x-schemaName: BaseProductOption + properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. + required: + - id + - title BaseProductOptionValue: type: object description: The product option value's details. x-schemaName: BaseProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. BaseProductTag: type: object description: The tag's tags. @@ -24945,11 +25028,7 @@ components: - order properties: order: - type: string - title: order - description: The order's details. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/StoreOrder' StorePaymentCollection: type: object description: The payment collection's details. diff --git a/www/utils/generated/oas-output/schemas/AdminClaim.ts b/www/utils/generated/oas-output/schemas/AdminClaim.ts index d989eb68c6b33..dacff62bc64eb 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaim.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaim.ts @@ -80,11 +80,7 @@ * title: updated_at * description: The claim's update date. * order: - * type: string - * title: order - * description: The order's details. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/AdminOrder" * type: * type: string * description: The claim's type. diff --git a/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts index 66ee6341f5a1b..8f9dc90c027b8 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts @@ -8,11 +8,7 @@ * - claim * properties: * order: - * type: string - * title: order - * description: The order change's order. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/Order" * claim: * $ref: "#/components/schemas/AdminClaim" * diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts index 06e04377d50ff..7cbadb6e15e78 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts @@ -1,7 +1,7 @@ /** * @schema AdminCreateShippingOption * type: object - * description: The shipping option's type. + * description: The shipping option's details. * x-schemaName: AdminCreateShippingOption * required: * - label diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts index e1fad25b4a31b..6289aaf162708 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts @@ -1,7 +1,7 @@ /** * @schema AdminCreateShippingOptionRule * type: object - * description: The rule's rules. + * description: The details of the shipping option rule. * x-schemaName: AdminCreateShippingOptionRule * required: * - operator @@ -10,7 +10,7 @@ * properties: * operator: * type: string - * description: The rule's operator. + * description: The operator used to check whether a rule applies. * enum: * - gt * - lt @@ -23,18 +23,21 @@ * attribute: * type: string * title: attribute - * description: The rule's attribute. + * description: The name of a property or table that the rule applies to. + * example: customer_group * value: * oneOf: * - type: string * title: value - * description: The rule's value. + * description: A value of the attribute that enables this rule. + * example: cusgroup_123 * - type: array - * description: The rule's value. + * description: Values of the attribute that enable this rule. * items: * type: string * title: value - * description: The value's details. + * description: A value of the attribute that enables this rule. + * example: cusgroup_123 * */ diff --git a/www/utils/generated/oas-output/schemas/AdminExchange.ts b/www/utils/generated/oas-output/schemas/AdminExchange.ts index bd2c7e99cb41b..e5ce683e19458 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchange.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchange.ts @@ -93,11 +93,7 @@ * title: deleted_at * description: The date the exchange was deleted. * order: - * type: string - * title: order - * description: The order's details. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/AdminOrder" * allow_backorder: * type: boolean * title: allow_backorder diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts index e8db2e9e917af..aaeac3d197169 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts @@ -8,11 +8,8 @@ * - exchange * properties: * order: - * type: string - * title: order - * description: The order change's order. - * externalDocs: - * url: "#pagination" + * description: The details of the associated order. + * $ref: "#/components/schemas/Order" * exchange: * $ref: "#/components/schemas/AdminExchange" * diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts index b583fb39b83fc..944b249271c52 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts @@ -7,11 +7,7 @@ * - order * properties: * order: - * type: string - * title: order - * description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/AdminOrderPreview" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts index 327af2cba188b..d16749e467729 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts @@ -7,11 +7,7 @@ * - order * properties: * order: - * type: string - * title: order - * description: The order's details. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/AdminOrder" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts index cb1c190254136..97033bd4a24cb 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts @@ -8,11 +8,7 @@ * - return * properties: * order: - * type: string - * title: order - * description: The order change's order. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/Order" * return: * $ref: "#/components/schemas/AdminReturn" * diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts index 003088203973e..1edcddeb7b289 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts @@ -15,7 +15,7 @@ * unit_price: * type: number * title: unit_price - * description: The order edit's unit price. + * description: The item's unit price. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts index 5c58de788555b..bedc1cbb76132 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts @@ -17,7 +17,7 @@ * unit_price: * type: number * title: unit_price - * description: The order edit's unit price. + * description: The item's unit price. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts index e7aeb271ab888..ca576cd19437b 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts @@ -18,7 +18,7 @@ * description: The URL of the user's avatar. * metadata: * type: object - * description: The user's metadata. + * description: The user's metadata, can hold custom key-value pairs. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductImage.ts b/www/utils/generated/oas-output/schemas/BaseProductImage.ts index bc8de0c5d7b16..c258e914f7f7d 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductImage.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductImage.ts @@ -3,6 +3,36 @@ * type: object * description: The image's details. * x-schemaName: BaseProductImage + * properties: + * id: + * type: string + * title: id + * description: The image's ID. + * url: + * type: string + * title: url + * description: The image's URL. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the image was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the image was updated. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the image was deleted. + * metadata: + * type: object + * description: The image's metadata, can hold custom key-value pairs. + * required: + * - id + * - url * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductOption.ts b/www/utils/generated/oas-output/schemas/BaseProductOption.ts index e09afe7bab247..62664b620fe2d 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductOption.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductOption.ts @@ -3,6 +3,47 @@ * type: object * description: The product option's details. * x-schemaName: BaseProductOption + * properties: + * id: + * type: string + * title: id + * description: The option's ID. + * title: + * type: string + * title: title + * description: The option's title. + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The option's product id. + * values: + * type: array + * description: The option's values. + * items: + * $ref: "#/components/schemas/BaseProductOptionValue" + * metadata: + * type: object + * description: The option's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The option's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The option's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The option's deleted at. + * required: + * - id + * - title * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts b/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts index a7dbcad8e3ced..af37e68f433b6 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts @@ -3,6 +3,42 @@ * type: object * description: The product option value's details. * x-schemaName: BaseProductOptionValue + * required: + * - id + * - value + * properties: + * id: + * type: string + * title: id + * description: The value's ID. + * value: + * type: string + * title: value + * description: The value. + * option: + * $ref: "#/components/schemas/BaseProductOption" + * option_id: + * type: string + * title: option_id + * description: The ID of the option this value belongs to. + * metadata: + * type: object + * description: The value's metadata, can hold custom key-value pairs. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the value was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the value was updated. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the value was deleted. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts b/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts index 342789541ab0e..40c4f78c2df99 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts @@ -7,11 +7,7 @@ * - order * properties: * order: - * type: string - * title: order - * description: The order's details. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/StoreOrder" * */