Commit Graph

78 Commits

Author SHA1 Message Date
Shahed Nasser
781d0ca624 docs: added docs for reset password (#9306)
- Added to docs on implementing auth flows using the module and API routes how to update a user's password
- Added guide on how to send a notification when a password token is generated
- Added a guide on implementing reset password flow in storefront
- Added OAS for the `/update` and `/reset-password` routes + generated specs for the API reference
2024-10-07 08:04:01 +00:00
github-actions[bot]
21badd069d chore(docs): Updated API Reference (v2) (#9437)
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-10-03 07:48:54 +00:00
Shahed Nasser
a94f30ba97 chore(oas): add more details link to pagination and select fields (#9414)
find-and-replace to add a link to the pagination and field selection sections in parameters.

Closes DOCS-940
2024-10-02 18:41:51 +00: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
74b3385a65 chore(oas): [21/21] improve oas schemas (#9339)
* improve oas

* more improvements

* add missing descriptions

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-27 12:40:24 +02:00
Shahed Nasser
229da19029 chore(oas): [20/n] improve oas schemas (#9337)
Improve oas schemas [20/n]
2024-09-26 17:21:07 +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
c5bf22f3f4 chore(oas): [17/n] improve OAS schemas (#9284)
Improve OAS schemas [17/n]
2024-09-26 13:07:07 +00:00
Shahed Nasser
97b72f4662 oas: [15/n] improve oas schemas (#9216)
Improve OAS schemas [15/n]

Note: validation error will be fixed once #9218 is merged
2024-09-26 13:03:41 +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
cebffc7a11 chore(oas): [13/n] improve oas schemas (#9201)
* chore(oas): [13/n] improve oas schemas

* remove tax region name
2024-09-22 14:50:26 +02: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
426c39c04b chore(oas): [14/n] improve OAS schemas (#9202)
* chore(oas): [14/n] improve OAS schemas

* fix description of required_quantity
2024-09-19 18:52:46 +02:00
Shahed Nasser
d6ce0688db chore(oas): [10/n] improve oas schemas (#9167)
* chore(oas): [10/n] improve oas schemas

* fix validation error

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-19 18:51:55 +02: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
89928dfdf3 chore(oas): [11/n] improve oas schemas (#9188)
Improve OAS schemas [11/n]
2024-09-19 14:24:54 +00:00
Shahed Nasser
d2c48228df chore(oas): [9/n] improve oas schemas (#9166) 2024-09-17 19:27:28 +02:00
Shahed Nasser
b5ffed6973 chore(oas): [7/n] improve oas schemas (#9162) 2024-09-17 19:27:20 +02: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
05c88268d3 oas: update authorization header in cURL examples (#9100) 2024-09-16 20:42:06 +03:00
Shahed Nasser
35ffaf73d7 docs: update store cURL examples in OAS (#9099) 2024-09-16 15:37:11 +03:00
Shahed Nasser
2c8ae6073e oas: [6/n] improve oas schemas (#9122)
Improve oas schemas [6/n]
2024-09-13 07:23:09 +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
abb5f0c2fe oas: [4/n] improve oas schemas (#9064)
Improve oas schemas [4/n]
2024-09-09 18:52:49 +00:00
Shahed Nasser
2189ff2dc8 chore: fix build errors in OAS (#9059)
Fix errors stopping OAS from building
2024-09-09 13:54:14 +00:00
Shahed Nasser
4b8d9cc735 oas: [3/n] improve oas schemas (#9042)
Improve oas schemas [3/n]
2024-09-07 06:16:00 +00:00
Shahed Nasser
a7180e29b8 oas: [1/n] improve store oas (#8993)
* oas: [1/n] improve store oas

* add missing postal code param
2024-09-07 08:09:10 +02:00
Shahed Nasser
7a80593b68 oas: [2/n] improve schema oas (#9040) 2024-09-06 18:53:07 +03:00
Shahed Nasser
0482b7751d oas: [1/n] improve oas schemas (#9039) 2024-09-06 18:52:51 +03: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
github-actions[bot]
cf3c25addf chore(docs): Updated API Reference (v2) (#9033)
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-06 12:25:48 +00:00
Shahed Nasser
72f7ff882d chore: fix incorrect oas property name (#9009) 2024-09-06 12:59:11 +02: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
c424d397f6 oas: [14/14] improve admin oas (#8989) 2024-09-04 19:36:27 +03: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
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
8e177538c1 oas: [10/n] improve admin oas (#8959) 2024-09-03 13:29:58 +03: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
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
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
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