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
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
Shahed Nasser
22a629670b
docs: add sidebar item for helper reference + examples fix ( #8365 )
2024-07-31 17:28:42 +03: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
Shahed Nasser
4bd77174f0
docs-util: fix knowledge base for functions ( #8337 )
2024-07-30 12:52:08 +03: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
Shahed Nasser
157fa3c80f
docs: remove js client and medusa react references ( #8270 )
2024-07-26 10:11:37 +03:00
Shahed Nasser
71ebcd1bd0
docs: fix module definition for providers ( #8180 )
2024-07-18 18:59:53 +02: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
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
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
Shahed Nasser
72f7500c84
chore(docs): DML API Reference ( #7863 )
...
* added dml options
* added tsdocs + configurations
2024-07-01 10:21:56 +03:00
Shahed Nasser
6e65158af3
docs-util: Upgrade typedoc to 0.26 ( #7853 )
...
Upgrade typedoc to v0.26 + make changes based on the update
Note: This update produces an error when generating model references when the models use the `createPsqlIndexStatementHelper` decorator. As this isn't a breaking error, and as we'll move to DML in the future, it's not necessary to spend time on a fix.
2024-06-27 10:52:44 +00:00
Shahed Nasser
922fff4051
docs-util: fixes and improvements to OAS generator ( #7731 )
...
* fixed associated schema names
* move OAS method and summary descriptions to knowledge base
* refactoring and fixes
* detect default object value in delete responses
2024-06-26 11:54:09 +03:00
Shahed Nasser
7e7e6e3311
chore: fix OAS circular dependencies ( #7693 )
2024-06-12 19:42:03 +02:00
Shahed Nasser
6798bd9a0d
docs-util: fix path to packages in mermaid plugin ( #7640 )
2024-06-06 20:25:34 +03:00
Shahed Nasser
6646a203df
chore(types, utils): add TSDocs for AbstractNotificationProviderService ( #7556 )
...
Add TSDocs for `AbstractNotificationProviderService` which will be used to generate a reference on how to create a notification provider module.
2024-06-04 13:36:06 +00:00
Shahed Nasser
28d2a5347a
chore(types, utils): added TSDocs for file provider module ( #7553 )
...
* chore(types, utils): added TSDocs for file provider module
* fix import
2024-06-03 10:18:02 +02:00
Shahed Nasser
70e1de7742
docs: change module paths in resolve ( #7539 )
...
Change the path to modules in the resolve property across docs
2024-06-03 07:41:30 +00:00
Shahed Nasser
6b86b1d531
chore(types): add TSDocs to the user module's types ( #7549 )
2024-05-30 18:04:44 +03:00
Shahed Nasser
fe96bd39b1
docs: change config snippets to use defineConfig ( #7546 )
2024-05-30 16:47:28 +03:00
Shahed Nasser
ddfd757277
fix(docs-util): recognize optional zod parameters ( #7538 )
...
* fix(docs-util): recognize optional zod parameters
* remove admin/auth as an authenticated route path
2024-05-30 16:47:16 +03:00
Shahed Nasser
2c5ba408d4
docs: edits and fixes to commerce module docs ( #7468 )
...
Apply edits and fixes to the commerce modules docs
2024-05-29 11:08:06 +00:00
Shahed Nasser
98615c388b
docs-util: fixes to base OAS + circular-patch redocly plugin ( #7382 )
...
* docs-util: remove MultipleErrors schema from base OAS
* fixes to circular patch plugin
* general fixes
* change nested schemas to references
2024-05-27 14:29:48 +02:00
Shahed Nasser
6ab7cbd529
chore: fixes to ConfigModule's docblocks ( #7390 )
2024-05-22 13:40:53 +03:00
Shahed Nasser
154673f3d8
docs: fixes and changes based on latest updates ( #7322 )
...
* docs: changes based on DX changes
* remove fields no longer needed
* remove unnecessary parameters
* fixes to authenticate middleware usage
* add highlight to migrations config
* change configuration to http
* added missing remote link docs
* fix name in sidebar
* added notification module docs + updated file module docs
* add vale exceptions
* fix vale errors
* added docs on custom cli scripts
2024-05-22 13:37:48 +03:00
Riqwan Thamir
442b0b2038
chore: rename route from api-v2 to api ( #7379 )
...
* chore: rename route from api-v2 to api
* chore: change oas references
* chore: remove v2 ref
2024-05-21 10:44:02 +02:00
Shahed Nasser
cd312287f5
docs-util: add type argument of MedusaRequest as query parameter for get requests ( #7359 )
2024-05-20 09:51:37 +03:00
Shahed Nasser
803e4aad02
docs: added file module docs ( #7278 )
2024-05-13 18:54:59 +03:00
Shahed Nasser
e960f10aba
fix(docblock-generator): fix how type names created from Zod objects are inferred ( #7292 )
2024-05-10 21:06:55 +03:00
Shahed Nasser
489a54e1fb
fix(docblock-generator): eslint errors + missing await ( #7281 )
...
* chore: add missing await in docblock generator
* add fix for undefined symbol
* fix dirname path
2024-05-09 17:23:59 +03:00
Shahed Nasser
7b2879d643
chore(docs): Fix docblock-generator OAS tool's max-stack error ( #7246 )
...
* regenerate oas to fix duplicate keys
* fix clean:oas script
* fix max-stack errors
* fix max-level condition
2024-05-06 13:41:59 +03:00
Shahed Nasser
b39de05535
chore: move docs-util to www ( #7232 )
...
* reorganize docs apps
* add README
* fix directory
* add condition for old docs
* move docs-util to www
* remove remaining docs-util
* fixes of paths
* fix scripts
* path fixes
* fix github actions
* add build packages script
2024-05-06 09:13:50 +03:00
