Commit Graph

24 Commits

Author SHA1 Message Date
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
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
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
78eaed70e5 chore(oas): [8/n] improve oas schemas (#9163)
Improve OAS schemas [8/n]
2024-09-17 17:26:41 +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
464a3e692f docs-util: fix after updating node version (#9072)
Small fix in imports after updating node version
2024-09-10 12:05:19 +00:00
Shahed Nasser
5eafa5a184 oas: [5/n] improve oas schemas (#9066)
Improve oas schemas [5/n]
2024-09-10 12:03:18 +00:00
Shahed Nasser
4ffcc41fe7 chore(utils): update auth provider TSDocs + fix errors stopping references build (#9023)
- Updated the TSDocs of the auth provider
- Update the Node version in the docs-util as the outdated version was causing TypeScript error
- Add `@ts-ignore` for a line that was causing a typescript error. If there's a better fix here let me know
2024-09-09 13:53:33 +00:00
Shahed Nasser
cd909f9db3 oas: [2/2] improve store OAS (#9035) 2024-09-06 18:52:38 +03:00
Shahed Nasser
a28c911c24 docs: update auth docs + add new storefront guides (#9020)
* docs: update auth docs + add new storefront guides

* lint content

* fix vale error

* add callback response schema

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* address PR comments

* replace google -> github

* better explanation for refresh token

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03: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
090cb36543 docs-utils: fix auth detection + added query params (#8997) 2024-09-04 19:36:10 +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
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
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
c86a9fe864 docs-util: fix removal of manually-added schemas in clean script (#8840) 2024-08-29 10:22:50 +03:00
Shahed Nasser
af6d43f0f0 docs-util: fix for product type schemas (#8837) 2024-08-28 12:54:35 +03:00
Shahed Nasser
0c4f4c8a11 docs: updates following authentication flow changes (#8706)
* docs: updates following authentication flow changes

* generate sidebar

* added open api specs

* fix up OAS

* changes to existing pages

* change sidebar items

* update marketplace recipe
2024-08-27 15:47:39 +03:00
Shahed Nasser
f0f83afdd9 docs-util: fix update OAS schema (#8556)
* docs-util: fix update OAS schema

* fix to updating

* fix condition
2024-08-16 12:37:03 +03:00
Shahed Nasser
92a7b5b4c0 docs-util: fix OAS generation error (#8577) 2024-08-14 11:21:22 +03:00
Shahed Nasser
163205a9a2 docs-util: associate an API route with the workflow it uses (#8554) 2024-08-13 09:56:06 +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