Commit Graph

56 Commits

Author SHA1 Message Date
Shahed Nasser
30e620a43c docs: support deprecated in API reference (#12438) 2025-05-12 09:10:35 +03:00
Shahed Nasser
e09b2a4db5 docs: support version in events reference (#12422)
* docs: support version in events reference

* remove changes in events output

* remove events emitted in comments

* remove customer updated event

* check for emitEventStep usage

* fixes
2025-05-09 14:34:15 +03:00
Shahed Nasser
262064fe96 docs: show events emitted in an API route in the API reference (#12392)
* docs: show events emitted in an API route in the API reference

* fix build error

* support version tag

* add missing property
2025-05-07 14:56:54 +03:00
Shahed Nasser
5d3f1d0118 docs-util: add events to generated OAS (#12390) 2025-05-07 10:44:02 +03:00
Shahed Nasser
70a99a2434 docs: generate events reference (#12341)
* docs: generate events reference

* change link in navbar

* fix redirect
2025-05-01 19:39:53 +03:00
Shahed Nasser
91f5ac91a9 docs-util: add script to generate events info (#12340)
* docs-util: add script to generate events info

* add property and parent name to json
2025-05-01 14:44:24 +03:00
Shahed Nasser
2bfe936185 docs-util: support deprecated tag in OAS (#12339) 2025-05-01 11:59:48 +03:00
Shahed Nasser
cd66cdd2bb docs: generate OAS manually for 2.7.0 (#12158)
* original changes

* changes

* fixes for delete operations

* generate oas
2025-04-11 16:41:39 +03:00
Shahed Nasser
82d774b395 docs-util: add a prefix for JS SDK examples in OAS (#11989) 2025-03-26 13:28:23 +02:00
Shahed Nasser
178e034561 docs-util: sort examples to show JS SDK first (#11986) 2025-03-25 19:25:34 +02:00
Shahed Nasser
83e063229b docs-utils: support routes that include global variables (#11976)
* docs-util: support urls that have variable names

* re-generate examples

* disable removing js sdk examples and replace with warning
2025-03-25 15:36:00 +02:00
Shahed Nasser
8a302130b3 docs-util: add JS SDK examples to generated OAS (#11935) 2025-03-25 11:11:48 +02:00
Shahed Nasser
df5ae50612 docs-util: add tool to generate mapping between JS SDK examples and routes (#11933)
* initial implementation

* finish implementation

* add js sdk key
2025-03-21 15:34:52 +02:00
Shahed Nasser
08ce70a368 docs-util: add exceptions for routes with custom auth middleware (#11755) 2025-03-06 13:05:50 +02:00
Shahed Nasser
be566ca6fb docs: fix OAS generator + generate OAS (#11584) 2025-02-24 15:30:38 +02:00
Shahed Nasser
dd487f02e1 docs-util: fix issue with creating StoreProductType OAS schema (#11180) 2025-01-27 17:33:46 +02:00
Shahed Nasser
97280cd928 docs-util: fix incorrect workflow extracted in OAS (#11120) 2025-01-23 19:21:16 +02:00
Shahed Nasser
c5915451b8 docs-util: add examples generator for workflows and steps (#10914)
* initial changes

* docs-util: generate examples for workflows and steps
2025-01-10 19:16:43 +02:00
Shahed Nasser
bd73716bb6 docs-util: add warning on request body change (#10881) 2025-01-08 21:40:46 +02:00
Shahed Nasser
edcff0ed16 docs-util: fixes to OAS generator + generate OAS (#10867) 2025-01-07 16:35:55 +02:00
Shahed Nasser
91ebf6d61c docs-util: add publishable api key header parameter to store routes OAS (#10747)
* docs-util: add publishable api key header parameter to store routes OAS

* fix oas
2024-12-26 16:27:55 +02:00
Shahed Nasser
9a05888538 docs-util: fix query params not retrieved correctly for some routes (#10708) 2024-12-23 17:43:28 +02:00
Shahed Nasser
abdd4c9e99 docs-util: support new query type argument (#10468)
* add support for second query argument

* more fixes
2024-12-06 12:21:19 +02:00
Shahed Nasser
9b76d2a2d0 docs-util: fix build errors (#10275) 2024-11-25 19:38:29 +02:00
github-actions[bot]
7865909891 chore(docs): Updated API Reference (automated) (#10258)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-11-25 14:33:22 +00:00
github-actions[bot]
f997432e73 chore(docs): Updated API Reference (automated) (#9728)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:42:32 +00:00
Shahed Nasser
2b77bd85a6 docs-util: fixes for OAS docs generator + framework typedoc config (#9603)
* fix order replaced in OAS response + framework tsdoc config

* fix for some types
2024-10-16 12:17:28 +03:00
Shahed Nasser
5fb9c1f82e chore(oas): general fixes to OAS (#9413)
General fixes to OAS
2024-10-02 15:21:40 +00:00
Shahed Nasser
1e144e9c08 chore(oas): clean up oas (#9354)
* clean up generated oas

* fix issues in docs-util

* more fixes

* align max level

* validation fix

* add missing summaries

* fix validation

* fix exchanges route
2024-10-02 10:27:02 +03:00
Shahed Nasser
bd4d2fd554 docs-util: fixes following packages reorg (#9326)
- Typescript config aren't picked up properly anymore since they're moved to `_tsconfig.base.json` in the root. So, we now read the config from the config file.
- Update Typescript version in the `utils` monorepo to match that of the root monorepo
2024-09-26 17:22:08 +00:00
Shahed Nasser
be1adac024 chore(oas): [18/n] improve oas schemas (#9311)
Improve OAS schemas [18/n]
2024-09-26 14:08:10 +00:00
Shahed Nasser
af34bf6c0c chore(oas): [19/n] improve oas schemas (#9317)
- Improve OAS schemas [19/n]
- docs-generator: combine `Date | string` type to just `Date`.
2024-09-26 13:44:57 +00:00
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