Commit Graph

65 Commits

Author SHA1 Message Date
Shahed Nasser 53cdbaa069 chore: generate and update OAS for translations (#14281)
* chore: generate and update OAS for translations

* support localization header

* add locale to all store routes

* fixes

* small fix
2025-12-16 15:52:33 +02:00
Shahed Nasser c3cebdfe80 docs: fix events payloads (#14131) 2025-11-26 16:12:00 +02:00
Shahed Nasser 22ca22a2f0 docs: fix callback validation for third-party authentication (#14109)
* docs: fix callback validation for third-party authentication

* address comment
2025-11-24 15:43:05 +02:00
Shahed Nasser 6cd40c9f74 docs: fix broken links in OAS (#14000) 2025-11-07 10:48:37 +02:00
Shahed Nasser 604ff55a5b docs: generate OAS for 2.11.2 (#13925) 2025-10-31 16:15:46 +02:00
github-actions[bot] 3d0f4086b4 chore(docs): Updated API Reference (automated) (#13794)
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>
2025-10-21 09:14:39 +00:00
Shahed Nasser fcb977a989 docs: remove mention of base64 requirement for api keys (#13679) 2025-10-03 14:10:16 +03:00
Shahed Nasser 2f990a14e6 docs: generate API reference for 2.10.3 (#13548)
* docs: generate API reference for 2.10.3

* fix curl example
2025-09-19 11:40:52 +03:00
Shahed Nasser 9f7df88c84 docs: add clarification for set cart's customer API route (#13506) 2025-09-15 14:32:36 +03:00
Shahed Nasser 2657f9c196 docs: add manage promotions in cart storefront guide (#13483)
* docs: add manage promotions in cart storefront guide

* fix incorrect cURL example
2025-09-15 12:29:55 +03:00
Shahed Nasser 522fc12d7a docs: change from detecting version to since tag (#13127)
* update everything from version to since

* update events

* regenerate oas
2025-08-01 18:22:42 +03:00
Shahed Nasser 9bb4c0306b docs: fix to OAS generator following Zod update + generate API reference (#13030) 2025-07-24 14:36:28 +03:00
Shahed Nasser 5527d95b5c docs: add a troubleshooting section on creating a payment session with zero total (#12974) 2025-07-16 14:26:40 +03:00
Shahed Nasser 7d95eb73d3 docs: update OAS for loyalty plugin (#12836)
* updates

* cleanup

* generate OAS

* update links
2025-06-26 17:22:18 +03:00
github-actions[bot] 7ac734ca21 chore(docs): Updated API Reference (automated) (#12826)
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>
2025-06-25 12:18:41 +00:00
Shahed Nasser 93cf79cb0f docs: add loyalty plugin routes to OAS (#12811)
* generated OAS

* remove unused schemas

* generated specs

* add cloud badge for routes

* add to loyalty plugin page

* allow clicking the tooltip
2025-06-24 19:17:55 +03:00
github-actions[bot] c6c660c4d3 chore(docs): Updated API Reference (automated) (#12461)
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>
2025-05-13 13:43:58 +00: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 a3bdb3e383 docs: generate OAS with events (#12394)
* docs: generate OAS with events

* small change
2025-05-07 14:57:03 +03:00
Shahed Nasser 97daa5a41c docs: clarify ISO format for province codes (#12282)
* docs: clarify ISO format for province codes

* regenerate
2025-04-24 15:44:35 +03:00
github-actions[bot] c7065fcd2b chore(docs): Updated API Reference (automated) (#12268)
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>
2025-04-23 08:50:17 +00:00
Shahed Nasser a3aa5d7a66 dos: add docs on overriding allowed fields in routes (#12233) 2025-04-18 11:38:36 +03:00
Shahed Nasser eb73bdb478 docs: rename Architectural Modules to Infrastructure Modules (#12212)
* docs: rename Architectural Modules to Infrastructure Modules

* generate again
2025-04-17 13:20:43 +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 c2e24b6cfd docs: update OAS of reset password routes (#11711) 2025-03-04 13:28:41 +02:00
Shahed Nasser 40a9cffb34 docs: add more clarification to reset password in API reference (#11695) 2025-03-03 18:09:03 +02:00
Shahed Nasser 3a6818e3c4 docs: generate OAS after cart promotion fixes (#11351) 2025-02-07 10:12:09 +02:00
Shahed Nasser b61af03a63 docs: fix description of update cart OAS (#11278) 2025-02-03 14:34:26 +02:00
github-actions[bot] 3e81962503 chore(docs): Updated API Reference (automated) (#11167)
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>
2025-01-27 11:45:04 +00:00
Shahed Nasser 4250c292eb docs: fix authentication callback descriptions to include all query parameters (#10932) 2025-01-13 15:12:06 +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
github-actions[bot] 4479ecdc7b chore(docs): Updated API Reference (automated) (#10641)
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-12-17 17:41:22 +00:00
Shahed Nasser cccce65ef9 docs: fix bugs in API reference (#10557) 2024-12-11 18:32:58 +02:00
github-actions[bot] c9eeaebdd9 chore(docs): Updated API Reference (automated) (#10437)
* chore(docs): Generated API Reference (automated)

* fixes

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-12-04 20:31:03 +02:00
Shahed Nasser 263dbf7872 docs: update details on retrieving nested categories (#10317) 2024-11-27 18:52:33 +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
Shahed Nasser 4810b1c55b chore: fix cURL example in create payment collection route (#10219)
* chore: fix cURL example in create payment collection route

* regenerate OAS
2024-11-22 14:22:50 +02: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
github-actions[bot] 8209d936a0 chore(docs): Updated API Reference (v2) (#9666)
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-18 17:14:26 +00:00
github-actions[bot] b40fa6353e chore(docs): Updated API Reference (v2) (#9552)
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-14 11:00:04 +00:00
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 be1adac024 chore(oas): [18/n] improve oas schemas (#9311)
Improve OAS schemas [18/n]
2024-09-26 14:08:10 +00:00
Shahed Nasser 35ffaf73d7 docs: update store cURL examples in OAS (#9099) 2024-09-16 15:37:11 +03: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