Patrick and GitHub
a027d5ff9e
chore(oas): PascalCase for schemas + remove x-resourceId ( #2847 )
...
### What
Rename all JSDoc OAS `@schema` and `$ref: #/components/schemas/` from snake_case to PascalCase, `foo_bar -> FooBar`
Extra scope: Remove `x-resourceId` from JSDoc OAS.
### Why
Classes use PascalCase as a convention but the OAS @schemas describing them were using snake_case. OAS code generators tend to use the schema name when generating typed models.
In order to avoid mismatch between source code, the OAS, and the generated client code, it is advised to align OAS @schemas formatting to the classes they represent.
Extra scope: x-resourceId is not a widely used OAS property. It's current usage in our OAS does not provide additional value. Therefore, we recommend to remove it in order to have one less item to maintain.
### How
Good old search & replace. Regex search to further make sure we didn't miss any.
The scope is limited to `@schema` definition and their usage in `$ref: #/components/schemas/`.
### Test
* Ran OAS validator.
* Ran docs build script.
Expect no visible changes to the documentation.
Resolves: CORE-852, CORE-859
2022-12-20 10:58:57 +00:00
Philip Korsholm and GitHub
79cddc23da
feat(medusa-file-s3): Allow all AWS options in config ( #2809 )
2022-12-20 10:01:30 +01:00
Oliver Windall Juhl and GitHub
ba6bb3e54b
feat(medusa): Extract cron job logic to its own service ( #2821 )
...
**What**
Extract cron job logic from the `EventBusService` to its own service `JobSchedulerService`
**Why**
Preliminary step to extracting the event bus into a module
**Tests**
Tested with a local installation of Medusa
Resolved CORE-918
2022-12-19 19:04:46 +00:00
Shahed Nasser and GitHub
e5e13cc40e
docs: added order claim documentation ( #2805 )
2022-12-14 20:25:12 +02:00
Shahed Nasser and GitHub
e2b7f77ba9
docs: fix id used in endpoint path in OAS ( #2795 )
...
* docs: fix id used in endpoint path in OAS
* docs: small fixes to OAS comments
* revert changes in core package
* undo changes in core files
2022-12-14 11:54:31 +02:00
Shahed Nasser and GitHub
319bcc71b0
docs: updated event reference ( #2791 )
...
* docs: updated events reference
* docs: added noCopy metadata option for code blocks
2022-12-13 18:14:53 +02:00
Shahed Nasser and GitHub
52a8e90aac
chore(docs): Generated API reference ( #2788 )
2022-12-13 12:52:58 +02:00
Shahed Nasser and GitHub
a77b4a1b7e
docs: changed the steps to run tests in local dev ( #2786 )
2022-12-13 12:47:21 +02:00
e174443ecf
chore(docs): Generated JS Client Reference (automated) ( #2780 )
...
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
2022-12-13 12:40:33 +02:00
Shahed Nasser and GitHub
76d35a1350
docs: made changes to CORS usage/config ( #2784 )
2022-12-13 12:32:51 +02:00
Shahed Nasser and GitHub
7227c1539b
docs: added a note about using Yarn for installation ( #2778 )
...
* docs: added a note about yarn being faster
* docs: fixed env variable used in admin deployment guide
* docs: fixed the use of noReport with npm2yarn
2022-12-13 11:52:55 +02:00
Shahed Nasser and GitHub
6c796bf582
docs: added a minimum Node.js version for admin ( #2779 )
...
* docs: added a note about min node version in admin
* docs: added a link to Vite documentation
2022-12-13 11:52:37 +02:00
Shahed Nasser and GitHub
beecd4947d
docs: added an upgrade guide for 1.7.0 ( #2750 )
2022-12-13 10:36:52 +01:00
6b51dd0168
docs: update environment variable used in admin's deploy guides ( #2748 )
...
* docs: Update netlify deploy readme for clarity
It was unlcear why "Gatsby" was mentioned in the env name for the server URL. Also, the code shows precedence given to `MEDUSA_BACKEND_URL` now:
```
__MEDUSA_BACKEND_URL__: JSON.stringify(
env.MEDUSA_BACKEND_URL ||
// Backwards-compat with Gatsby.
env.GATSBY_MEDUSA_BACKEND_URL ||
env.GATSBY_STORE_URL ||
""
),
```
Therefore, this should be indicated in the documentation.
* Update docs/content/deployments/admin/deploying-on-netlify.md
* Update deploying-on-netlify.md
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
2022-12-13 10:16:01 +02:00
9021037397
docs: use correct publish directory for netlify deploy ( #2741 )
...
* Use correct publish directory for netlify deploy
Netlify automatically sets the Publish directory as "dist," but the netlify admin app's `build` command outputs files to `public`.
* Update docs/content/deployments/admin/deploying-on-netlify.md
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
* Netlify CLI instructions updated to match UI
* Update docs/content/deployments/admin/deploying-on-netlify.md
* Update docs/content/deployments/admin/deploying-on-netlify.md
* Update deploying-on-netlify.md
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
2022-12-13 10:12:58 +02:00
Shahed Nasser and GitHub
64a4dcc53b
docs: fixed tabs in create-medusa-app ( #2762 )
2022-12-12 13:27:48 +02:00
Shahed Nasser and GitHub
0d1e73f152
docs: added Klarna documentation ( #2746 )
2022-12-08 20:26:35 +02:00
Shahed Nasser and GitHub
a57177ded5
docs: redesigned code blocks ( #2745 )
...
* docs: redesigned code blocks to include titles
* docs: added a title where necessary
2022-12-08 18:52:54 +02:00
Shahed Nasser and GitHub
8efae2dfcf
docs: added details about admin analytics in usage documentation ( #2733 )
2022-12-06 18:14:07 +02:00
Shahed Nasser and GitHub
2ffeaf567f
docs: delete unused doc files ( #2732 )
2022-12-06 18:13:38 +02:00
Shahed Nasser and GitHub
7363cae339
docs: Added Manage Discounts using Admin APIs doc ( #2730 )
2022-12-06 16:43:13 +02:00
Shahed Nasser and GitHub
f19e4de636
docs: added Use Discounts in Checkout documentation ( #2717 )
2022-12-02 16:10:54 +02:00
Shahed Nasser and GitHub
c729921180
docs: fixes to discounts documentation percentage ( #2711 )
...
* docs: fixes to discounts documentation
* docs: added a note about regions for fixed discount
2022-12-01 17:37:56 +02:00
Shahed Nasser and GitHub
b54405e3de
docs: added Discounts Architecture documentation ( #2709 )
...
* docs: added discounts architecture documentation
* docs: fix tooltip text showing in the copied text
* docs: added missing link
2022-12-01 16:08:27 +02:00
Shahed Nasser and GitHub
6cea109caa
docs: added user guide for Manage Discounts ( #2706 )
2022-11-30 19:24:34 +02:00
Shahed Nasser and GitHub
7bee40c6f3
docs: added Create a Discount user guide ( #2705 )
2022-11-30 17:32:43 +02:00
Shahed Nasser and GitHub
663e262cc4
docs: added deploy to railway docs ( #2697 )
2022-11-29 19:16:18 +02:00
Shahed Nasser and GitHub
657ada6fb0
docs: added credentials option to fetch examples ( #2694 )
2022-11-29 17:21:19 +02:00
Shahed Nasser and GitHub
a917b0a109
docs: small fixes across the documentation ( #2692 )
...
* docs: various bug fixes
* docs: add the import in other storage plugins
* docs: fixed the placement of manual taxes doc
2022-11-29 16:29:55 +02:00
Shahed Nasser and GitHub
0c8bdf4dad
docs: fixed error in code in override price selection ( #2689 )
2022-11-29 14:54:17 +02:00
4f3a7c9048
chore(docs): Generated Entities Reference (automated) ( #2680 )
...
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com >
2022-11-28 13:11:03 +02:00
6aee2e2265
chore(docs): Generated Services Reference (automated) ( #2663 )
...
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
2022-11-28 11:02:51 +02:00
d9f9d7ac28
chore(docs): Generated Entities Reference (automated) ( #2661 )
...
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
2022-11-28 11:02:34 +02:00
ee14155eb7
chore(docs): Generated JS Client Reference (automated) ( #2660 )
...
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
2022-11-28 11:02:11 +02:00
3cee0bc8fc
chore(docs): Generated API Reference ( #2649 )
...
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
2022-11-28 10:59:43 +02:00
Shahed Nasser and GitHub
208809b635
docs: update readme ( #2587 )
...
* docs: added features list
* docs: update readme
2022-11-10 17:52:03 +02:00
Shahed Nasser and GitHub
7b96bb1f1a
docs: added settings user guides ( #2586 )
2022-11-10 16:31:56 +02:00
Shahed Nasser and GitHub
657d0a6586
docs: added user guide for tax-inclusive pricing ( #2580 )
2022-11-10 14:44:17 +02:00
Shahed Nasser and GitHub
8f39ee26d9
docs: temporary fix for memory error that occurs during build ( #2584 )
...
* docs: temporary fixes for build error
* docs: added env variable to the build step
* docs: undo unnecessary updates
2022-11-10 14:04:34 +02:00
88ac804b63
chore(docs): Generated Services Reference (automated) ( #2575 )
...
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
2022-11-10 10:36:05 +02:00
557352cdfe
chore(docs): Generated JS Client Reference (automated) ( #2576 )
...
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
2022-11-10 10:35:17 +02:00
441690e90c
chore(docs): Generated Entities Reference (automated) ( #2571 )
...
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com >
2022-11-09 18:30:17 +02:00
325b1e9017
chore(docs): Generated API Reference ( #2572 )
...
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com >
2022-11-09 18:30:06 +02:00
Shahed Nasser and GitHub
9e7e8c6d51
docs: migrated images to cloudinary from imgur ( #2569 )
2022-11-09 16:30:41 +02:00
Shahed Nasser and GitHub
0a31ea9d43
docs: added "users" user guides ( #2565 )
...
* docs: added "users" user guides
* docs: added user trial link to footer
2022-11-08 17:55:45 +02:00
Shahed Nasser and GitHub
1167970211
docs: added manage collections user guide ( #2564 )
2022-11-08 13:30:43 +02:00
Shahed Nasser and GitHub
e16d076ffc
docs: added manage customer user guide ( #2562 )
2022-11-07 19:42:41 +02:00
Shahed Nasser and GitHub
c00971423e
docs: added upgrade guide for 1.6.1 ( #2561 )
2022-11-07 18:59:58 +02:00
Shahed Nasser and GitHub
c0639ef708
docs: added code blocks without headers ( #2560 )
2022-11-07 17:36:51 +02:00
Shahed Nasser and GitHub
52666a8538
docs: general design fixes ( #2545 )
...
* general fixes to the docs design
* fix condition checking for auto color scheme
2022-11-04 12:30:55 +02:00
PatrickandGitHub
Philip KorsholmandGitHub
Oliver Windall JuhlandGitHub
Shahed NasserandGitHub
