Commit Graph

45 Commits

Author SHA1 Message Date
github-actions[bot] 3b632c5130 chore(docs): Generated API Reference (#2991)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-11 17:43:03 +02:00
github-actions[bot] c62e309629 chore(docs): Generated API Reference (#2935)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-03 16:26:45 +02:00
github-actions[bot] cd32795595 chore(docs): Generated API Reference (#2927)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-03 10:40:03 +02:00
github-actions[bot] d93d337df7 chore(docs): Updated API Reference (#2903)
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>
2022-12-26 16:30:38 +00:00
github-actions[bot] 4814045036 chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
Patrick a027d5ff9e chore(oas): PascalCase for schemas + remove x-resourceId (#2847)
### What

Rename all JSDoc OAS `@schema` and `$ref: #/components/schemas/` from snake_case to PascalCase, `foo_bar -> FooBar`

Extra scope: Remove `x-resourceId` from JSDoc OAS.

### Why

Classes use PascalCase as a convention but the OAS @schemas describing them were using snake_case. OAS code generators tend to use the schema name when generating typed models.

In order to avoid mismatch between source code, the OAS, and the generated client code, it is advised to align OAS @schemas formatting to the classes they represent.

Extra scope: x-resourceId is not a widely used OAS property. It's current usage in our OAS does not provide additional value. Therefore, we recommend to remove it in order to have one less item to maintain.

### How

Good old search & replace. Regex search to further make sure we didn't miss any.

The scope is limited to `@schema` definition and their usage in `$ref: #/components/schemas/`.

### Test

* Ran OAS validator.
* Ran docs build script.

Expect no visible changes to the documentation.

Resolves: CORE-852, CORE-859
2022-12-20 10:58:57 +00:00
Shahed Nasser e2b7f77ba9 docs: fix id used in endpoint path in OAS (#2795)
* docs: fix id used in endpoint path in OAS

* docs: small fixes to OAS comments

* revert changes in core package

* undo changes in core files
2022-12-14 11:54:31 +02:00
Shahed Nasser 52a8e90aac chore(docs): Generated API reference (#2788) 2022-12-13 12:52:58 +02:00
github-actions[bot] 3cee0bc8fc chore(docs): Generated API Reference (#2649)
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
2022-11-28 10:59:43 +02:00
github-actions[bot] 325b1e9017 chore(docs): Generated API Reference (#2572)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-11-09 18:30:06 +02:00
github-actions[bot] 10b9b0dc49 chore(docs): Generated API Reference (#2417)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-10-11 16:11:11 +03:00
Shahed Nasser 14d4b9d95c chore: generate API reference (#2410) 2022-10-11 10:30:45 +03:00
Shahed Nasser d516e04699 docs: Added pattern usage sections in the API Reference (#2332)
* docs: added usage patterns in API Reference

* docs: added pattern usage to storefront api ref
2022-10-04 15:49:53 +03:00
github-actions[bot] 9ead8aedd1 chore(docs): Generated API Reference (#2218)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-09-15 16:07:31 +03:00
github-actions[bot] 6e0258f36c chore(docs): Generated API Reference (#2191)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-09-13 10:59:51 +03:00
github-actions[bot] a1350bfaec chore(docs): Generated API Reference (#2143)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-09-05 10:23:46 +03:00
Shahed Nasser 4961aece1c docs: Add request and error examples (#2109) 2022-09-04 20:08:05 +02:00
github-actions[bot] b98a09dd9f chore(docs): Generated API Reference (#2120)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-08-29 14:39:35 +03:00
github-actions[bot] 605fa625a2 chore(docs): Generated API Reference (#2100)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-08-25 18:31:58 +03:00
Shahed Nasser cef081d2f2 docs: Change :id to {id} in OAS comments (#2015) 2022-08-08 16:35:13 +02:00
Shahed Nasser 73383cc466 chore(docs): Refactor API Reference (#1883) 2022-08-05 14:06:12 +02:00
Shahed Nasser 2bd5e08f40 docs: update api reference (#1798) 2022-07-05 20:34:27 +03:00
Shahed Nasser 08c63097f9 docs: Update api reference (#1410) 2022-05-24 13:22:42 +02:00
olivermrbl d7971ba604 fix: merge conflicts with master 2022-04-27 14:21:03 +02:00
Shahed Nasser 8ceb895d9c docs: improve performance of API reference (#1247) 2022-04-05 11:22:25 +02:00
Philip Korsholm b164977a19 Feat: Medusa react price list (#1258)
* export everything from price lists in core

* medusa-js price list

* feat: add product list for price lists

* feat: add product list for price lists

* add price list to admin module

* add price list hooks initial

* refactor: product list controller

* fix: add integration test for price list products

* update types

* add tests for price lists

* update medusa react tests

* update update request for price lists

* Apply suggestions from code review

Co-authored-by: Sebastian Rindom <skrindom@gmail.com>

* rename methods

* pr feedback

* list products from price list

* fix errors after merge

* update medusa react with medusa-js method name changes

* redo changes

* update hook names

* fix: routes in msw handler

Co-authored-by: Sebastian Rindom <skrindom@gmail.com>
Co-authored-by: Zakaria El Asri <zakaria.elas@gmail.com>
2022-04-03 20:48:49 +02:00
Shahed Nasser ee0db7b4c3 Docs: update api reference (#1213)
* Updated API reference

* fixed error for requests with no response
2022-03-23 20:12:37 +01:00
0xflotus 9f03c51fbb fix: grammar (#1209) 2022-03-23 20:11:05 +01:00
Sebastian Rindom 3ea6aea5be fix: updates documentation and fixes script blockers (#765) 2021-11-10 09:18:16 +01:00
Sebastian Rindom ae82cfc70a feat: creates support for swaps on the storefront (#355) 2021-08-30 12:14:56 +02:00
Kasper Fabricius Kristensen 143f06aa39 feat: Update to API references look and feel (#343)
Co-authored-by: Vadim Smirnov <smirnou.vadzim@gmail.com>
Co-authored-by: zakariasaad <zakaria.elas@gmail.com>
Co-authored-by: Vilfred Sikker <vilfredsikker@gmail.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
2021-08-20 10:26:29 +02:00
Sebastian Rindom 9467f7ecbd fix: build openapi (#338) 2021-08-16 15:45:50 +02:00
Sebastian Rindom 49f1d0f67a fix: merge 2021-03-16 22:39:29 +01:00
Sebastian Rindom 31d5bb017d fix: merge 2021-03-16 22:27:09 +01:00
Sebastian Rindom 3d0dff58c4 docs: fixture improvements + small fixes (#204)
* fix: deref arrays

* docs: clean up

* fix: update license
2021-03-16 18:15:41 +01:00
Sebastian Rindom 6ad2b0e6e9 fix: merge api 2021-03-15 08:28:53 +01:00
Sebastian Rindom 7c7f86e8e8 fix: allows shipping option filters in return (#202)
* fix: allows shipping option filters in return

* fix: test

* chore: update fixtures

* docs: update openapi
2021-03-12 14:23:03 +01:00
Sebastian Rindom ca74226d4a docs: add new endpoints 2021-03-11 08:39:44 +01:00
Sebastian Rindom 1e5a1398d8 hotfix: docs build (#198)
* fix: build

* fix: build

* fix: build

* fix: build
2021-03-10 16:15:06 +01:00
Sebastian Rindom 8edb32c742 docs: oas (#197)
Adds OpenAPI specification of Storefront and Admin APIs.
Updates docs project.
2021-03-10 11:51:54 +01:00
Oliver Windall Juhl 6f1da4ff7d docs: fix cart documentation 2021-02-12 08:44:43 +01:00
Sebastian Rindom f1baca3cbd Replaces MongoDB support with PostgreSQL (#151)
- All schemas have been rewritten to a relational model
- All services have been rewritten to accommodate the new data model
- Adds idempotency keys to core endpoints allowing you to retry requests with no additional side effects
- Adds staged jobs to avoid putting jobs in the queue when transactions abort
- Adds atomic transactions to all methods with access to the data layer

Co-authored-by: Oliver Windall Juhl <oliver@mrbltech.com>
2021-01-26 10:26:14 +01:00
olivermrbl 34e6c52745 chore: updates API reference docs 2020-12-15 13:49:45 +01:00
Sebastian Rindom 47e2ad2952 docs: adds first version of REST docs (#116) 2020-09-30 21:17:22 +02:00
Sebastian Rindom 51aaf5105c Completes Cart Service and store/carts endpoints (#18)
Completes Cart Service to allow shopping and checkout flows.
2020-03-16 09:48:52 +01:00