Commit Graph

1062 Commits

Author SHA1 Message Date
github-actions[bot]
25082c60cc chore(docs): Generated References (#9007)
Generated the following references:
- `auth`
- `auth_provider`
- `core_flows`
- `modules`
- `order_models`
- `types`
2024-09-05 10:18:20 +00:00
Shahed Nasser
beaa851302 docs-util: fix to enum type + optional (#8950)
- Fix to some enum types (with one member) not being extracted properly.
- Consider `nullish` Zod types as optional.
2024-09-04 18:36:58 +00:00
Shahed Nasser
c615f4014c chore: fix oas errors (#8982)
Fix indentation and missing values in OAS resulting in an error when generating the specs in the API reference
2024-09-04 18:34:17 +00:00
Shahed Nasser
951b4a8100 docs: fixes to testing tool guides (#8981) 2024-09-04 18:24:49 +00:00
Shahed Nasser
1d54e8fdc1 docs: add new API route guides + fixes and improvements to existing ones (#8987)
- Add new documentation pages for API route intro, responses, errors, and validation
- General fixes and improvements across existing API route guides

> Note: I didn't work on the guide for additional data validation. Will work on this as part of my next focus on workflows.
2024-09-04 18:23:55 +00:00
Shahed Nasser
c424d397f6 oas: [14/14] improve admin oas (#8989) 2024-09-04 19:36:27 +03:00
Shahed Nasser
090cb36543 docs-utils: fix auth detection + added query params (#8997) 2024-09-04 19:36:10 +03:00
github-actions[bot]
91d0bb0260 chore(docs): Generated References (#8979)
Generated the following references:
- `core_flows`
- `fulfillment`
- `modules`
- `order`
- `promotion`
- `types`
2024-09-04 06:38:54 +00:00
Shahed Nasser
f47f1aff49 oas: [13/n] improve admin oas (#8971)
Improve the OAS of admin API routes [13/n]
2024-09-03 16:59:37 +00:00
Shahed Nasser
58f297cc75 docs: added documentation on testing tools (#8939)
- Added documentation on how to use Medusa's tools from the `medusa-test-utils` package to create integration and unit tests.
- Added a manual reference on the `medusaIntegrationTestRunner` and `moduleIntegrationTestRunner` functions. Since the typings in the source code aren't very informative, I opted for a manual reference shedding light on the important bits.

Closes DOCS-852
2024-09-03 14:50:45 +00:00
Shahed Nasser
e9fce4c5c2 docs: improvements to intro and basics chapters (#8956) 2024-09-03 17:34:07 +03:00
Shahed Nasser
7e278bef76 oas: [11/n] improve admin OAS (#8963) 2024-09-03 17:33:45 +03:00
Shahed Nasser
ee2c297caa oas: [12/n] improve admin oas (#8967) 2024-09-03 17:32:58 +03:00
Shahed Nasser
46a70eaf5b docs: added a section on middlewares and trailing backslashes (#8942) 2024-09-03 17:32:36 +03:00
Shahed Nasser
f9b0605d67 docs: generate sitemaps + change search filters (#8957)
- Generate sitemaps for `book` and `resources` projects (in attempt to resolve some pages not being picked up by the crawler)
- Change the v2 search filters

> Note: will require changes to algolia's crawler + a recrawl once merged
2024-09-03 10:33:08 +00:00
Shahed Nasser
8e177538c1 oas: [10/n] improve admin oas (#8959) 2024-09-03 13:29:58 +03:00
github-actions[bot]
508d5d720c chore(docs): Generated References (#8953)
Generated the following references:
- `cart`
- `core_flows`
- `customer`
- `medusa_config`
- `modules`
- `types`
2024-09-03 07:20:00 +00:00
github-actions[bot]
edc19e748b chore(docs): Updated API Reference (v2) (#8954)
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-09-03 07:18:42 +00:00
Shahed Nasser
1a63209290 oas: [8/n] improve admin OAS (#8945)
Improve the OAS of admin API routes [8/n]
2024-09-03 06:45:11 +00:00
Shahed Nasser
f98bb7e2b4 docs: small fixes to marketplace recipe (#8932) 2024-09-02 15:39:58 +03:00
github-actions[bot]
d6dcda5b8f chore(docs): Updated API Reference (v2) (#8929)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-09-02 07:45:24 +00:00
Shahed Nasser
a969223ada oas: [5/n] Improve admin OAS (#8898)
Improve the OAS of admin API routes [5/n]
2024-09-02 07:08:47 +00:00
Shahed Nasser
bc7d17cea4 oas: [4/n] Improve admin OAS (#8893)
Improve the OAS of admin API routes [4/n]
2024-09-02 07:07:56 +00:00
github-actions[bot]
01758c8a28 chore(docs): Generated DML JSON files (#8928)
This PR holds all generated DML JSON files for the upcoming release.
2024-09-02 07:00:49 +00:00
Shahed Nasser
ba653692e1 oas: [6/n] Improve admin OAS (#8901) 2024-09-02 09:39:27 +03:00
Shahed Nasser
1f2ee24e1d oas: [7/n] Improve admin OAS (#8902) 2024-09-02 09:39:14 +03:00
Shahed Nasser
0d24262bbe docs: fix missing auth tag in api reference (#8903) 2024-09-01 11:42:27 +02:00
Shahed Nasser
7e92aa412c chore(framework): add a note for admin path configuration + add troubleshooting guide (#8905)
- add a note in the `path` configuration regarding same path as docker image
- Add a section in the troubleshooting guide for the same reason
2024-09-01 07:46:32 +00:00
Shahed Nasser
c8f951dd89 docs: fixes and improvements to auth flow documentation (#8909) 2024-08-30 20:14:16 +03:00
Shahed Nasser
dea5af085a docs-util: fix clean script removing Auth tags (#8911)
* docs-util: fix clean script removing Auth tags

* fix removal of response types other than json
2024-08-30 17:02:02 +03:00
Attila Turcsan
b9eac4402b Update page.mdx (#8908)
Fix API route path in the example.
2024-08-30 13:11:32 +00:00
Shahed Nasser
8c82207a41 docs: replace usages of migrations and links commands (#8894) 2024-08-30 11:48:49 +03:00
Shahed Nasser
bab6ad4c55 oas: [3/n] Improve admin OAS (#8875)
Improve the OAS of admin API routes [3/n]
2024-08-30 07:20:20 +00:00
github-actions[bot]
184ce379a6 chore(docs): Generated References (automated) (#8889)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-08-30 08:35:16 +02:00
github-actions[bot]
524be62312 chore(docs): Generated API Reference (v2) (#8890)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-08-30 08:35:10 +02:00
Shahed Nasser
8cf47516c1 docs: use new x-sidebar-summary for sidebar items in api-reference if available (#8865)
Use the new `x-sidebar-summary` OAS attribute when adding operations to the sidebar, if available.
2024-08-29 17:14:10 +00:00
Shahed Nasser
44d4af3a3f oas: [1/n] Improve admin OAS (#8850) 2024-08-29 20:07:33 +03:00
Shahed Nasser
75c5853163 oas: [2/n] Improve admin OAS (#8866) 2024-08-29 20:07:17 +03:00
Shahed Nasser
fbd93ab67c docs: fix tag filters in search (#8862) 2024-08-29 20:05:58 +03:00
Shahed Nasser
870a863503 docs: fix overflowing card description hidden (#8871) 2024-08-29 19:48:48 +03:00
Shahed Nasser
074b4ae0da docs-util: include types in workflows.ts in generated references (#8882) 2024-08-29 18:42:26 +02:00
github-actions[bot]
4e6e81f445 chore(docs): Updated API Reference (v2) (#8870)
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>
2024-08-29 13:05:50 +00:00
Shahed Nasser
9290ce88bf docs-util: fixes in schema factory + other improvements (#8874)
- Split schema factory for request / response / common types
- Fix overlapping types "string" and "regexp" to be just one string type
- If `oneOf` or `allOf` OAS schemas have one item, just use that item's type.
2024-08-29 12:35:45 +00:00
github-actions[bot]
37ebc97d82 chore(docs): Generated References (#8860)
Generated the following references:
- `fulfillment_models`
- `modules`
- `notification`
- `order`
- `order_models`
- `types`
2024-08-29 09:46:46 +00:00
Shahed Nasser
84fb9d55f3 docs: incorrect link fixes (#8868)
Few link fixes

Closes #8856
2024-08-29 09:44:55 +00:00
Shahed Nasser
ddddd4303c docs: add restaurant-delivery marketplace recipe (#8817)
Add recipe for restaurant-delivery marketplace recipe inspired by Medusa Eats

Closes DOCS-921

Preview: https://resources-docs-git-docs-restaurant-delivery-recipe-medusajs.vercel.app/v2/resources/recipes/marketplace/examples/restaurant-delivery
2024-08-29 09:33:31 +00:00
Shahed Nasser
25134d2307 docs-util: improvements and fixes to OAS generation (#8855)
- Add to knowledge base summaries for delete-related properties
- Fix long curl examples overflowing the line
- Fix singular / plural usage in some knowledge base descriptions / summaries
- Fix some workflows not picked up
- Remove query params for routes that don't use them.
2024-08-29 08:40:55 +00:00
Shahed Nasser
70f2290a22 docs: added documentation for db commands (#8846)
* docs: added documentation for db commands

* fix lint errors
2024-08-29 10:46:00 +03:00
Shahed Nasser
c86a9fe864 docs-util: fix removal of manually-added schemas in clean script (#8840) 2024-08-29 10:22:50 +03:00
Shahed Nasser
22d92aa70a docs: add tracking for navigation usage (#8819) 2024-08-28 15:44:54 +03:00