Commit Graph

73 Commits

Author SHA1 Message Date
Shahed Nasser
c870302400 docs-util: added workflows typedoc plugin (#8463)
* initial changes

* finish workflow plugin

* add comments

* remove todo
2024-08-06 14:23:24 +03:00
github-actions[bot]
413e29837c chore(docs): Generated References (#8461)
Generated the following references:
- `medusa`
- `modules`
- `types`
2024-08-06 07:07:15 +00:00
github-actions[bot]
80e44576fc chore(docs): Generated References (#8440)
Generated the following references:
- `product`
2024-08-05 06:52:39 +00:00
github-actions[bot]
71f0d24359 chore(docs): Generated References (#8400)
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `currency`
- `customer`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `medusa`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `workflows`
2024-08-02 07:05:39 +00:00
Shahed Nasser
5ed5b45cce chore(utils, types): updated TSDocs of AbstractPaymentProvider (#8335)
- Update the TSDocs of `AbstractPaymentProvider`
- Remove old TSDocs of `IPaymentProvider`
- Update the config that generates the payment module provider reference.

Closes DOCS-781
2024-08-01 15:50:34 +00:00
Shahed Nasser
4a95a48e94 docs-util: mark type parameters as optional (#8320)
Mark all type parameters in references as optional.

Closes DOCS-802
2024-08-01 15:45:41 +00:00
github-actions[bot]
31ec4d0d71 chore(docs): Updated API Reference (v2) (#8384)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-08-01 07:43:40 +00:00
github-actions[bot]
66cc7cfc1f chore(docs): Generated References (#8383)
Generated the following references:
- `helper_steps`
- `modules`
- `types`
- `workflows`
2024-08-01 07:04:13 +00:00
github-actions[bot]
da3da51000 chore(docs): Generated DML JSON files (#8382)
This PR holds all generated DML JSON files for the upcoming release.
2024-08-01 07:04:02 +00:00
Shahed Nasser
22a629670b docs: add sidebar item for helper reference + examples fix (#8365) 2024-07-31 17:28:42 +03:00
github-actions[bot]
749e86b5d8 chore(docs): Updated API Reference (v2) (#8361)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-07-31 07:33:02 +00:00
github-actions[bot]
aac906f058 chore(docs): Generated References (#8360)
Generated the following references:
- `currency_models`
- `medusa_config`
- `region_models`
- `types`
2024-07-31 07:31:20 +00:00
github-actions[bot]
69ddd1e081 chore(docs): Generated DML JSON files (#8359)
This PR holds all generated DML JSON files for the upcoming release.

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-07-31 07:30:29 +00:00
Shahed Nasser
fffd4f2b3b docs-util: support generating helper steps (#8354) 2024-07-30 19:06:16 +03:00
Shahed Nasser
d4c9c1e7cd docs-util: fix how data model name is inferred (#8351) 2024-07-30 18:59:29 +03:00
github-actions[bot]
8a5751c115 chore(docs): Generated DML JSON files (#8343)
This PR holds all generated DML JSON files for the upcoming release.

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-07-30 11:47:57 +00:00
Shahed Nasser
4bd77174f0 docs-util: fix knowledge base for functions (#8337) 2024-07-30 12:52:08 +03:00
github-actions[bot]
a2a377c8ca chore(docs): Updated API Reference (v2) (#8345)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-07-30 07:30:58 +00:00
github-actions[bot]
5389f7ca63 chore(docs): Generated References (#8344)
Generated the following references:
- `fulfillment`
- `medusa_config`
- `modules`
- `order`
- `order_models`
- `types`
- `workflows`
2024-07-30 07:29:34 +00:00
Shahed Nasser
ebaf0eb53a docs-util: rename docblock-generator to docs-generator (#8331)
* docs-util: rename docblock-generator to docs-generator

* change program name

* fix action
2024-07-29 16:04:33 +03:00
Shahed Nasser
7ad4e7b1c9 docs: added typedoc plugin to parse DML json files (#8300)
* docs-util: add docblock generator for models built with DML

* add missing turbo task

* docs-util: added typedoc plugin to parse dml json files
2024-07-29 14:19:04 +02:00
Shahed Nasser
f9d86683e5 docs-util: update knowledge base of docblock-generator (#8323)
* docs: update knowledge base for functions and filters

* fix build error
2024-07-29 12:34:25 +03:00
Shahed Nasser
d127abbcda docs-util: add docblock generator for models built with DML (#8296)
* docs-util: add docblock generator for models built with DML

* add missing turbo task
2024-07-29 10:11:39 +02:00
github-actions[bot]
cb33ec5cf1 chore(docs): Generated References (automated) (#8317)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-29 09:41:15 +02:00
github-actions[bot]
e40b4c6183 chore(docs): Generated API Reference (v2) (#8318)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-29 09:41:02 +02:00
github-actions[bot]
c6d6e3eff4 chore(docs): Generated References (#8289)
Generated the following references:
- `fulfillment`
- `medusa_config`
- `modules`
- `order`
- `types`
2024-07-26 08:20:04 +00:00
Shahed Nasser
157fa3c80f docs: remove js client and medusa react references (#8270) 2024-07-26 10:11:37 +03:00
github-actions[bot]
13855e9167 chore(docs): Updated API Reference (v2) (#8273)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-07-25 07:02:12 +00:00
github-actions[bot]
9f6a9620c7 chore(docs): Generated References (#8272)
Generated the following references:
- `medusa`
- `modules`
- `order`
- `types`
2024-07-25 07:01:52 +00:00
github-actions[bot]
b08d867e8f chore(docs): Generated API Reference (v2) (#8252)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-24 09:16:25 +02:00
github-actions[bot]
b9b65b7abb chore(docs): Generated References (automated) (#8251)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-24 09:16:14 +02:00
github-actions[bot]
1b61c9b309 chore(docs): Generated References (automated) (#8229)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-23 13:51:36 +02:00
github-actions[bot]
d71b0bac36 chore(docs): Generated API Reference (v2) (#8230)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-23 13:51:27 +02:00
github-actions[bot]
c99cb5c0ca chore(docs): Updated API Reference (v2) (#8208)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-07-22 07:10:08 +00:00
github-actions[bot]
9173dd4f5d chore(docs): Generated References (automated) (#8207)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-22 08:58:57 +02:00
Shahed Nasser
71ebcd1bd0 docs: fix module definition for providers (#8180) 2024-07-18 18:59:53 +02:00
github-actions[bot]
8ffcec3fc4 chore(docs): Generated References (automated) (#8174)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-18 14:49:53 +02:00
github-actions[bot]
7b49caf18a chore(docs): Generated API Reference (v2) (#8175)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-18 14:49:44 +02:00
github-actions[bot]
1d40b3cc98 chore(docs): Generated API Reference (v2) (#8155)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-17 08:34:42 +01:00
github-actions[bot]
238582ee67 chore(docs): Generated References (automated) (#8154)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-17 08:34:29 +01:00
Shahed Nasser
4c004cd287 docs-util: add support for RequestWithContext in route-handler detection (#8141)
* docs-util: update OAS docblock-generator to support RequestWithContext

* support alias type arguments in case there are no type arguments
2024-07-16 13:06:19 +03:00
github-actions[bot]
4f6af666da chore(docs): Generated References (automated) (#8138)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-16 10:59:12 +01:00
github-actions[bot]
8be8f065ef chore(docs): Generated References (automated) (#8121)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-14 18:02:46 +02:00
github-actions[bot]
ba06c9557c chore(docs): Generated References (automated) (#8099)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-12 09:32:00 +02:00
Carlos R. L. Rodrigues
de36e2b36e chore: rename return flow (#8050) 2024-07-10 08:09:10 -03:00
Shahed Nasser
20be64e799 docs-util: normalize primary key types in DML (#7941) 2024-07-04 17:35:24 +03:00
Shahed Nasser
964927b597 docs: general fixes and improvements (#7918)
* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step
2024-07-04 17:26:03 +03:00
Shahed Nasser
dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed Nasser
b9036eca1a docs: generate OAS for v2 (#7883) 2024-07-01 15:35:45 +03:00
Shahed Nasser
1f360a3245 docs-util: support models implemented with DML in typedoc custom plugins (#7847)
- Support generating reference for models implemented with DML
- Support resolving and generating mermaid diagram for relations

The Currency Module was used an example so its reference is generated to showcase the work of this PR.
2024-07-01 07:34:51 +00:00