diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh similarity index 67% rename from www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh rename to www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh index 6d7d71f581..ecf3ffe4f6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh @@ -1,11 +1,11 @@ -curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipment' \ +curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "items": [ { - "id": "id_eyih2debIPWMK4kaHGPZ", - "quantity": 7476297089417216 + "id": "id_5sTwO6Lz9h9W7f1U", + "quantity": 395722780311552 } ], "metadata": {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml index 1dc07dbed4..7066453be8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml @@ -1,6 +1,14 @@ type: object description: The parent's collection. x-schemaName: AdminCollection +required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata properties: id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml index 34f34c56f2..4958a3b256 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml @@ -39,10 +39,9 @@ properties: title: name description: The default tax rate's name. is_combinable: - type: string - enum: - - 'true' - - 'false' + type: boolean + title: is_combinable + description: The default tax rate's is combinable. metadata: type: object description: The default tax rate's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml index f4ae136c2c..0cc4883ba2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -25,7 +25,6 @@ required: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id @@ -49,6 +48,11 @@ properties: $ref: ./AdminProductVariant.yaml type: type: object + tags: + type: array + description: The parent's tags. + items: + $ref: ./AdminProductTag.yaml title: type: string title: title @@ -147,11 +151,6 @@ properties: type: string title: type_id description: The parent's type id. - tags: - type: array - description: The parent's tags. - items: - $ref: ./BaseProductTag.yaml images: type: array description: The parent's images. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml new file mode 100644 index 0000000000..c9dfaff0fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml @@ -0,0 +1,35 @@ +type: object +description: The tag's tags. +x-schemaName: AdminProductTag +required: + - id + - value + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The tag's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tag's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tag's deleted at. + metadata: + type: object + description: The tag's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml index 67e66e7550..791c465256 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml @@ -2,6 +2,7 @@ type: object description: SUMMARY x-schemaName: AdminUpdateTaxRate required: + - code - metadata properties: rate: diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml index 5daa766350..9d8d9258cf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml @@ -20,7 +20,6 @@ required: - material - collection_id - type_id - - tags - variants - options - images diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml index 73ed56e5b1..7bb84cb710 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -25,7 +25,6 @@ required: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 553feaead6..bb6c7d4b59 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -55,6 +55,8 @@ tags: x-associatedSchema: $ref: '#/components/schemas/AdminProductCategory' - name: Product Tags + x-associatedSchema: + $ref: '#/components/schemas/AdminProductTag' - name: Product Types - name: Products x-associatedSchema: @@ -7526,9 +7528,9 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/orders/{id}/fulfillments/{fulfillment_id}/shipment: + /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: post: - operationId: PostOrdersIdFulfillmentsFulfillment_idShipment + operationId: PostOrdersIdFulfillmentsFulfillment_idShipments summary: Add Shipments to Order description: Add a list of shipments to a order. x-authenticated: true @@ -7555,12 +7557,18 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7598,14 +7606,14 @@ paths: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipment' \ + curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "items": [ { - "id": "id_eyih2debIPWMK4kaHGPZ", - "quantity": 7476297089417216 + "id": "id_5sTwO6Lz9h9W7f1U", + "quantity": 395722780311552 } ], "metadata": {} @@ -7613,6 +7621,8 @@ paths: tags: - Orders responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -38518,6 +38528,14 @@ components: type: object description: The parent's collection. x-schemaName: AdminCollection + required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata properties: id: type: string @@ -39511,10 +39529,9 @@ components: title: name description: The default tax rate's name. is_combinable: - type: string - enum: - - 'true' - - 'false' + type: boolean + title: is_combinable + description: The default tax rate's is combinable. metadata: type: object description: The default tax rate's metadata. @@ -40099,7 +40116,6 @@ components: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id @@ -40123,6 +40139,11 @@ components: $ref: '#/components/schemas/AdminProductVariant' type: type: object + tags: + type: array + description: The parent's tags. + items: + $ref: '#/components/schemas/AdminProductTag' title: type: string title: title @@ -40221,11 +40242,6 @@ components: type: string title: type_id description: The parent's type id. - tags: - type: array - description: The parent's tags. - items: - $ref: '#/components/schemas/BaseProductTag' images: type: array description: The parent's images. @@ -40465,6 +40481,42 @@ components: properties: product: $ref: '#/components/schemas/AdminProduct' + AdminProductTag: + type: object + description: The tag's tags. + x-schemaName: AdminProductTag + required: + - id + - value + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The tag's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tag's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tag's deleted at. + metadata: + type: object + description: The tag's metadata. AdminProductVariant: type: object description: The updated's details. @@ -41673,6 +41725,7 @@ components: description: SUMMARY x-schemaName: AdminUpdateTaxRate required: + - code - metadata properties: rate: @@ -41932,7 +41985,6 @@ components: - material - collection_id - type_id - - tags - variants - options - images @@ -42637,7 +42689,6 @@ components: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 9f7ce5f36e..66f70dba0d 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -61,6 +61,8 @@ tags: x-associatedSchema: $ref: ./components/schemas/AdminProductCategory.yaml - name: Product Tags + x-associatedSchema: + $ref: ./components/schemas/AdminProductTag.yaml - name: Product Types - name: Products x-associatedSchema: @@ -192,8 +194,8 @@ paths: $ref: paths/admin_orders_{id}_fulfillments.yaml /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml - /admin/orders/{id}/fulfillments/{fulfillment_id}/shipment: - $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml + /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: + $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml /admin/payments: $ref: paths/admin_payments.yaml /admin/payments/payment-providers: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml similarity index 82% rename from www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml rename to www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml index 3d84c5cc77..c9f181a4d6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml @@ -1,5 +1,5 @@ post: - operationId: PostOrdersIdFulfillmentsFulfillment_idShipment + operationId: PostOrdersIdFulfillmentsFulfillment_idShipments summary: Add Shipments to Order description: Add a list of shipments to a order. x-authenticated: true @@ -28,20 +28,18 @@ post: data. - name: fields in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: >- + description: |- Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -85,10 +83,12 @@ post: label: cURL source: $ref: >- - ../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh + ../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh tags: - Orders responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml index 1dc07dbed4..7066453be8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml @@ -1,6 +1,14 @@ type: object description: The parent's collection. x-schemaName: AdminCollection +required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata properties: id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml index 34f34c56f2..4958a3b256 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml @@ -39,10 +39,9 @@ properties: title: name description: The default tax rate's name. is_combinable: - type: string - enum: - - 'true' - - 'false' + type: boolean + title: is_combinable + description: The default tax rate's is combinable. metadata: type: object description: The default tax rate's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml index f4ae136c2c..0cc4883ba2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -25,7 +25,6 @@ required: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id @@ -49,6 +48,11 @@ properties: $ref: ./AdminProductVariant.yaml type: type: object + tags: + type: array + description: The parent's tags. + items: + $ref: ./AdminProductTag.yaml title: type: string title: title @@ -147,11 +151,6 @@ properties: type: string title: type_id description: The parent's type id. - tags: - type: array - description: The parent's tags. - items: - $ref: ./BaseProductTag.yaml images: type: array description: The parent's images. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml new file mode 100644 index 0000000000..c9dfaff0fb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml @@ -0,0 +1,35 @@ +type: object +description: The tag's tags. +x-schemaName: AdminProductTag +required: + - id + - value + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The tag's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tag's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tag's deleted at. + metadata: + type: object + description: The tag's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml index 67e66e7550..791c465256 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml @@ -2,6 +2,7 @@ type: object description: SUMMARY x-schemaName: AdminUpdateTaxRate required: + - code - metadata properties: rate: diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml index 5daa766350..9d8d9258cf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml @@ -20,7 +20,6 @@ required: - material - collection_id - type_id - - tags - variants - options - images diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml index 73ed56e5b1..7bb84cb710 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -25,7 +25,6 @@ required: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index dd10b433b4..ab81ba48e7 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -3737,6 +3737,14 @@ components: type: object description: The parent's collection. x-schemaName: AdminCollection + required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata properties: id: type: string @@ -4730,10 +4738,9 @@ components: title: name description: The default tax rate's name. is_combinable: - type: string - enum: - - 'true' - - 'false' + type: boolean + title: is_combinable + description: The default tax rate's is combinable. metadata: type: object description: The default tax rate's metadata. @@ -5318,7 +5325,6 @@ components: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id @@ -5342,6 +5348,11 @@ components: $ref: '#/components/schemas/AdminProductVariant' type: type: object + tags: + type: array + description: The parent's tags. + items: + $ref: '#/components/schemas/AdminProductTag' title: type: string title: title @@ -5440,11 +5451,6 @@ components: type: string title: type_id description: The parent's type id. - tags: - type: array - description: The parent's tags. - items: - $ref: '#/components/schemas/BaseProductTag' images: type: array description: The parent's images. @@ -5684,6 +5690,42 @@ components: properties: product: $ref: '#/components/schemas/AdminProduct' + AdminProductTag: + type: object + description: The tag's tags. + x-schemaName: AdminProductTag + required: + - id + - value + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The tag's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tag's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tag's deleted at. + metadata: + type: object + description: The tag's metadata. AdminProductVariant: type: object description: The updated's details. @@ -6892,6 +6934,7 @@ components: description: SUMMARY x-schemaName: AdminUpdateTaxRate required: + - code - metadata properties: rate: @@ -7151,7 +7194,6 @@ components: - material - collection_id - type_id - - tags - variants - options - images @@ -7856,7 +7898,6 @@ components: - is_giftcard - collection_id - type_id - - tags - images - discountable - external_id