Commit Graph

203 Commits

Author SHA1 Message Date
Shahed Nasser
ea5bff9034 docs: update providers to use ModuleProvider (#9579)
Document change introduced by #9544

> Note: fine to merge now as it requires generating references, which will only happen after the next release.
2024-10-16 11:37:14 +00:00
Shahed Nasser
eed88c95ec docs: improved commerce modules [5/5] (#9592)
- Improve remaining commerce modules
- Other: add a note about using methods of the modules' main services.
2024-10-16 10:25:21 +00:00
Shahed Nasser
2b77bd85a6 docs-util: fixes for OAS docs generator + framework typedoc config (#9603)
* fix order replaced in OAS response + framework tsdoc config

* fix for some types
2024-10-16 12:17:28 +03:00
Shahed Nasser
714b9e6c98 docs: update resolve path to use src (#9605)
Update path used in `resolve` of modules to start with `src`
2024-10-16 09:10:30 +00:00
Shahed Nasser
6efb5897dc docs: fix package names in module registration (#9590)
* docs: fix package names in module registration

* update references
2024-10-16 09:05:07 +02:00
github-actions[bot]
f2d662efca chore(docs): Generated References (automated) (#9567)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-14 19:59:14 +02:00
github-actions[bot]
b40fa6353e chore(docs): Updated API Reference (v2) (#9552)
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>
2024-10-14 11:00:04 +00:00
Shahed Nasser
b6df24463d docs: updates for breaking changes (#9558)
- Update modules registration
- Update `medusa-config.js` to `medusa-config.ts`
- Update the out directory in the admin deployment guide
- Update logger imports
- Other fixes

Note: will need to re-generate references afterwards

Closes #9548
2024-10-14 10:40:30 +00:00
github-actions[bot]
224e530453 chore(docs): Generated References (#9551)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-10-14 10:33:21 +00:00
Shahed Nasser
dd162d69be docs-util: fix import in generated workflow hook snippet (#9499) 2024-10-11 17:17:02 +02:00
Shahed Nasser
781d0ca624 docs: added docs for reset password (#9306)
- Added to docs on implementing auth flows using the module and API routes how to update a user's password
- Added guide on how to send a notification when a password token is generated
- Added a guide on implementing reset password flow in storefront
- Added OAS for the `/update` and `/reset-password` routes + generated specs for the API reference
2024-10-07 08:04:01 +00:00
Shahed Nasser
bc8de8e5b1 docs: add section on testing providers (#9453) 2024-10-04 10:29:45 +03:00
github-actions[bot]
c536f7caf5 chore(docs): Generated References (automated) (#9436)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-10-03 11:03:35 +03:00
github-actions[bot]
21badd069d chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00
Shahed Nasser
a94f30ba97 chore(oas): add more details link to pagination and select fields (#9414)
find-and-replace to add a link to the pagination and field selection sections in parameters.

Closes DOCS-940
2024-10-02 18:41:51 +00:00
Shahed Nasser
5fb9c1f82e chore(oas): general fixes to OAS (#9413)
General fixes to OAS
2024-10-02 15:21:40 +00:00
Shahed Nasser
8686ca9d12 docs: updates and fixes in utils + fulfillment provider changes (#9347)
* fix config + update deps

* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser
1e144e9c08 chore(oas): clean up oas (#9354)
* clean up generated oas

* fix issues in docs-util

* more fixes

* align max level

* validation fix

* add missing summaries

* fix validation

* fix exchanges route
2024-10-02 10:27:02 +03:00
Shahed Nasser
2e16949979 docs: update imports and package names across docs (#9375)
* docs: update imports and package names across docs
+ reference configs

* generate files

* fix import

* change preview to rc
2024-10-01 11:03:42 +02:00
Shahed Nasser
74b3385a65 chore(oas): [21/21] improve oas schemas (#9339)
* improve oas

* more improvements

* add missing descriptions

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-27 12:40:24 +02:00
Shahed Nasser
bd4d2fd554 docs-util: fixes following packages reorg (#9326)
- Typescript config aren't picked up properly anymore since they're moved to `_tsconfig.base.json` in the root. So, we now read the config from the config file.
- Update Typescript version in the `utils` monorepo to match that of the root monorepo
2024-09-26 17:22:08 +00:00
Shahed Nasser
229da19029 chore(oas): [20/n] improve oas schemas (#9337)
Improve oas schemas [20/n]
2024-09-26 17:21:07 +00:00
Shahed Nasser
be1adac024 chore(oas): [18/n] improve oas schemas (#9311)
Improve OAS schemas [18/n]
2024-09-26 14:08:10 +00:00
Shahed Nasser
af34bf6c0c chore(oas): [19/n] improve oas schemas (#9317)
- Improve OAS schemas [19/n]
- docs-generator: combine `Date | string` type to just `Date`.
2024-09-26 13:44:57 +00:00
Shahed Nasser
c5bf22f3f4 chore(oas): [17/n] improve OAS schemas (#9284)
Improve OAS schemas [17/n]
2024-09-26 13:07:07 +00:00
Shahed Nasser
97b72f4662 oas: [15/n] improve oas schemas (#9216)
Improve OAS schemas [15/n]

Note: validation error will be fixed once #9218 is merged
2024-09-26 13:03:41 +00:00
Shahed Nasser
d352ea8122 chore(oas): [16/n] improve oas schemas (#9272)
- Improve OAS schemas [16/n]
- fixes and improvements to docs-generator tool
2024-09-26 13:02:32 +00:00
github-actions[bot]
9480deb71d chore(docs): Generated References (#9314)
Generated the following references:
2024-09-26 06:41:01 +00:00
Adrien de Peretti
e096feb7d5 chore: Update modules deps (#9286) 2024-09-26 11:14:35 +05:30
github-actions[bot]
16d2fdbfe6 chore(docs): Generated References (#9293)
Generated the following references:
2024-09-25 12:23:18 +00:00
github-actions[bot]
657a9fb90b chore(docs): Generated References (#9267)
Generated the following references:
- `medusa`
- `modules`
- `modules_sdk`
- `payment_provider`
- `workflows`
2024-09-24 07:02:49 +00:00
github-actions[bot]
4a68bc1334 chore(docs): Generated References (#9232)
Generated the following references:
- `modules`
- `modules_sdk`
- `types`
2024-09-23 07:33:39 +00:00
Shahed Nasser
cebffc7a11 chore(oas): [13/n] improve oas schemas (#9201)
* chore(oas): [13/n] improve oas schemas

* remove tax region name
2024-09-22 14:50:26 +02:00
Shahed Nasser
6a2a105cf8 fix(oas): support additional props, fix circular references patch, and other fixes (#9213)
* chore(oas): support additional props, fix circular references patch, and other fixes

* fix description

* description fixes
2024-09-20 17:22:19 +03:00
github-actions[bot]
2cb9322ef5 chore(docs): Generated References (automated) (#9206)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-09-20 09:25:55 +02:00
Shahed Nasser
426c39c04b chore(oas): [14/n] improve OAS schemas (#9202)
* chore(oas): [14/n] improve OAS schemas

* fix description of required_quantity
2024-09-19 18:52:46 +02:00
Shahed Nasser
d6ce0688db chore(oas): [10/n] improve oas schemas (#9167)
* chore(oas): [10/n] improve oas schemas

* fix validation error

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-19 18:51:55 +02:00
Shahed Nasser
4923a6e823 chore(oas): [12/n] improve oas schemas (#9200)
- improve OAS schemas [12/n]
- Support ignoring properties in type if it has the `@ignore` jsdoc tag.
2024-09-19 14:25:16 +00:00
Shahed Nasser
89928dfdf3 chore(oas): [11/n] improve oas schemas (#9188)
Improve OAS schemas [11/n]
2024-09-19 14:24:54 +00:00
github-actions[bot]
a00c2ddb31 chore(docs): Generated References (#9187)
Generated the following references:
- `modules`
2024-09-19 12:20:02 +00:00
github-actions[bot]
a63f6910d0 chore(docs): Generated References (automated) (#9169)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-09-18 08:07:01 +02:00
Shahed Nasser
d2c48228df chore(oas): [9/n] improve oas schemas (#9166) 2024-09-17 19:27:28 +02:00
Shahed Nasser
b5ffed6973 chore(oas): [7/n] improve oas schemas (#9162) 2024-09-17 19:27:20 +02:00
Shahed Nasser
78eaed70e5 chore(oas): [8/n] improve oas schemas (#9163)
Improve OAS schemas [8/n]
2024-09-17 17:26:41 +00:00
github-actions[bot]
175ca30f4f chore(docs): Generated References (#9153)
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
2024-09-17 07:17:55 +00:00
Shahed Nasser
cb79a5dbff docs-util: fixes for circular references, PAK in examples, namespaces (#9091)
- Fix circular references in generated OAS comments by cloning objects
- Add publishable API key in the header of store cURL examples + change the admin authentication header to use bearer tokens.
- Add plugin to generate namespaces from the `@customNamespace` tag in TSDocs, this was available before but was removed.
- Other fixes related to re-using schemas, overwritten descriptions, and smaller fixes
2024-09-16 17:55:05 +00:00
Shahed Nasser
05c88268d3 oas: update authorization header in cURL examples (#9100) 2024-09-16 20:42:06 +03:00
Shahed Nasser
8d3fb7fb2b docs: use require instead of import in medusa-config.js (#9102)
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2024-09-16 19:34:00 +02:00
Shahed Nasser
35ffaf73d7 docs: update store cURL examples in OAS (#9099) 2024-09-16 15:37:11 +03:00
Shahed Nasser
2c8ae6073e oas: [6/n] improve oas schemas (#9122)
Improve oas schemas [6/n]
2024-09-13 07:23:09 +00:00