Commit Graph

316 Commits

Author SHA1 Message Date
Shahed Nasser
9372a17d1f docs: generate API reference for 2.12.0 (#14185) 2025-12-02 11:56:37 +02:00
github-actions[bot]
21f61ec160 chore(docs): Generated References (automated) (#14182)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `inventory_next_models`
- `js_sdk`
- `module_events`
- `modules`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values.
> 
> - **Docs Generation**:
>   - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples.
> - **Fulfillment Workflows/Steps**:
>   - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`).
>   - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag.
>   - Refreshed example snippets and sample values.
> - **Notification Step** (`sendNotificationsStep`):
>   - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional.
>   - Output includes `provider_data` and `attachments` fields.
> - **Order Steps/Workflows**:
>   - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions.
>   - Example payloads adjusted (IDs, currencies, amounts).
> - **Meta**:
>   - Updated `<SourceCodeLink>` URLs to new commit hashes throughout.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-02 06:59:52 +00:00
github-actions[bot]
fa7bf50077 chore(docs): Generated DML JSON files (automated) (#14180)
This PR holds all generated DML JSON files for the upcoming release.


---

> [!NOTE]
> Updates generated DML JSONs with new fields and a renamed relation across fulfillment, notification, order, and promotion modules.
> 
> - **Fulfillment**:
>   - `ShippingOptionType`: rename `shipping_option` to `shipping_options` (expandable).
> - **Notification**:
>   - `Notification`: add `from` and `provider_data` fields.
> - **Order**:
>   - `OrderLineItemAdjustment`: add `version`.
>   - `Order`: add `custom_display_id`.
>   - `OrderChange`: add `carry_over_promotions` (since v2.12.0).
> - **Promotion**:
>   - `Promotion`: add `limit`, `used`, and `metadata` (since v2.12.0).
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 4494c93c2d7bc05cfec47fb1b77f7c4c16383f2b. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-02 06:50:03 +00:00
Shahed Nasser
c3cebdfe80 docs: fix events payloads (#14131) 2025-11-26 16:12:00 +02:00
Shahed Nasser
22ca22a2f0 docs: fix callback validation for third-party authentication (#14109)
* docs: fix callback validation for third-party authentication

* address comment
2025-11-24 15:43:05 +02:00
Shahed Nasser
66d4ba105e docs: generate OAS for 2.11.3 (#13973) 2025-11-12 09:24:54 +02:00
Shahed Nasser
6cd40c9f74 docs: fix broken links in OAS (#14000) 2025-11-07 10:48:37 +02:00
github-actions[bot]
924d651188 chore(docs): Generated References (automated) (#13969)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-11-05 16:47:09 +02:00
github-actions[bot]
ed5e4a1ef8 chore(docs): Generated DML JSON files (automated) (#13967)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-11-05 14:53:47 +02:00
Shahed Nasser
604ff55a5b docs: generate OAS for 2.11.2 (#13925) 2025-10-31 16:15:46 +02:00
github-actions[bot]
fffc1be1e7 chore(docs): Generated References (automated) (#13921)
* chore(docs): Generated References (automated)

* fix error + generate references

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-10-31 15:32:21 +02:00
github-actions[bot]
0928ded5d3 chore(docs): Generated DML JSON files (automated) (#13919)
* chore(docs): Generated DML JSON files (automated)

* update comments + add since

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-10-31 12:35:17 +02:00
github-actions[bot]
dbf8fb9bda chore(docs): Generated References (automated) (#13857)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-10-27 09:17:23 +02:00
github-actions[bot]
a76d5b63da chore(docs): Generated DML JSON files (automated) (#13855)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-10-27 08:52:33 +02:00
Shahed Nasser
c6e58e5144 docs: fixes to API and JS SDK references (#13795) 2025-10-21 13:32:25 +03:00
github-actions[bot]
3d0f4086b4 chore(docs): Updated API Reference (automated) (#13794)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-10-21 09:14:39 +00:00
github-actions[bot]
5bc9de9d2e chore(docs): Generated DML JSON files (automated) (#13790)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-10-21 11:56:47 +03:00
github-actions[bot]
858b3e3b9b chore(docs): Generated References (automated) (#13793)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-10-21 11:56:37 +03:00
Shahed Nasser
76f9da5ef4 docs: Caching Module (#13701)
* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
2025-10-21 10:34:27 +03:00
Shahed Nasser
fcb977a989 docs: remove mention of base64 requirement for api keys (#13679) 2025-10-03 14:10:16 +03:00
Shahed Nasser
2f990a14e6 docs: generate API reference for 2.10.3 (#13548)
* docs: generate API reference for 2.10.3

* fix curl example
2025-09-19 11:40:52 +03:00
Shahed Nasser
0e45249b30 docs: regenerate reference for views changes (#13551) 2025-09-19 10:45:55 +03:00
github-actions[bot]
138e340917 chore(docs): Generated References (automated) (#13544)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `order`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-09-19 06:21:46 +00:00
Shahed Nasser
8c21243f42 docs: add section on retrieve totals for cart items and shipping methods in storefront (#13513)
* docs: add section on retrieve totals for cart items and shipping methods in storefront

* change return type

* update OAS
2025-09-15 19:11:17 +03:00
Shahed Nasser
9f7df88c84 docs: add clarification for set cart's customer API route (#13506) 2025-09-15 14:32:36 +03:00
Shahed Nasser
55cf7a7b97 docs: regenerate core-flows reference to pick up locking steps (#13502) 2025-09-15 13:29:03 +03:00
Shahed Nasser
b35b1b41a4 chore: update API reference for 2.10.2 (#13499) 2025-09-15 12:30:09 +03:00
Shahed Nasser
2657f9c196 docs: add manage promotions in cart storefront guide (#13483)
* docs: add manage promotions in cart storefront guide

* fix incorrect cURL example
2025-09-15 12:29:55 +03:00
github-actions[bot]
c066fe993f chore(docs): Generated References (automated) (#13492)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-09-15 11:57:03 +03:00
Shahed Nasser
7b1028e5ae docs-util: fix workflows not picked for some routes + generate OAS (#13342)
* generated oas

* fixes and improvements
2025-08-29 12:51:55 +03:00
Shahed Nasser
899ac2f052 docs: generate references for 2.10.1 (#13344) 2025-08-29 12:51:43 +03:00
Shahed Nasser
5c6e172c61 docs: generate API reference for 2.10.0 (#13330) 2025-08-28 20:05:37 +03:00
github-actions[bot]
f239f38e58 chore(docs): Generated DML JSON files (automated) (#13328)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-08-28 18:57:18 +03:00
Shahed Nasser
de3fba6f86 docs: fix comment for shipment.created event (#13274) 2025-08-22 13:08:04 +03:00
github-actions[bot]
623cf05fab chore(docs): Generated References (automated) (#13206)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `order`
- `order_models`
- `payment_models`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `user_models`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-08-14 15:43:48 +00:00
github-actions[bot]
d73890d656 chore(docs): Generated API Reference (automated) (#13207)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-08-14 16:30:33 +03:00
Shahed Nasser
522fc12d7a docs: change from detecting version to since tag (#13127)
* update everything from version to since

* update events

* regenerate oas
2025-08-01 18:22:42 +03:00
Shahed Nasser
a48063ec26 docs: add link to manage metadata section in OAS and API reference (#13102) 2025-07-31 14:42:14 +03:00
Shahed Nasser
9bb4c0306b docs: fix to OAS generator following Zod update + generate API reference (#13030) 2025-07-24 14:36:28 +03:00
github-actions[bot]
0ccaa19918 chore(docs): Generated References (automated) (#13027)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-07-24 12:43:11 +03:00
Shahed Nasser
ed92aaf02b docs: add section on type aliases in admin + note for removing items from orders (#12996) 2025-07-18 18:35:58 +03:00
Shahed Nasser
5527d95b5c docs: add a troubleshooting section on creating a payment session with zero total (#12974) 2025-07-16 14:26:40 +03:00
github-actions[bot]
1503ba999f chore(docs): Generated References (automated) (#12942)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-07-14 14:39:48 +03:00
github-actions[bot]
3028425a86 chore(docs): Generated API Reference (automated) (#12943)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2025-07-14 13:41:40 +03:00
github-actions[bot]
8a5c846ba8 chore(docs): Generated DML JSON files (automated) (#12940)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2025-07-14 12:32:03 +03:00
Shahed Nasser
fc377a1360 chore(docs): fix generate OAS for gift card (#12937) 2025-07-14 11:42:28 +03:00
Shahed Nasser
a23bbc1cbb docs-util: throw when schema parsing fails (#12846) 2025-06-27 12:52:30 +03:00
Shahed Nasser
7d95eb73d3 docs: update OAS for loyalty plugin (#12836)
* updates

* cleanup

* generate OAS

* update links
2025-06-26 17:22:18 +03:00
github-actions[bot]
7ac734ca21 chore(docs): Updated API Reference (automated) (#12826)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-06-25 12:18:41 +00:00
github-actions[bot]
2b0c8c6662 chore(docs): Generated References (automated) (#12824)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-06-25 13:51:49 +03:00