asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
3,540 Commits 2 Branches 0 Tags
274056a38d5d820220b11c4a0d1ebab8ae3798e4
Commit Graph

70 Commits

Author SHA1 Message Date
github-actions[bot]
274056a38d chore(docs): Generated API Reference (#4205) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-05-31 17:10:23 +03:00
github-actions[bot]
7963c16233 chore(docs): Generated API Reference (#4054) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-05-09 18:12:00 +03:00
github-actions[bot]
0dbca9552e chore(docs): Generated API Reference (#4014) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-05-04 14:23:29 +03:00
github-actions[bot]
cce2b3827e chore(docs): Generated API Reference (#3935) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-04-26 20:57:23 +03:00
Philip Korsholm
2be144ff05 feat(medusa): Add purchasable prop on variants when setting availability (#3811) 
* write integration tests

* update variant inventory decorator

* update types

* add changeset

* feedback comments

* add yaml schemas

* different oas approach

* pr feedback

* update oas

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
 2023-04-20 08:54:26 +02:00
github-actions[bot]
bdd636c996 chore(docs): Generated API Reference (#3836) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-04-14 11:44:25 +02:00
github-actions[bot]
ab22b345eb chore(docs): Generated API Reference (#3826) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2023-04-13 15:29:48 +03:00
github-actions[bot]
d83fcfd9ea chore(docs): Generated API Reference (#3813) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-04-12 11:56:12 +02:00
Shahed Nasser
ae017c4657 chore(docs): merge changes from master (#3780) 
* chore(docs): Generated API Reference (#3761)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* docs: fix typo (#3771)

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Andre Schweighofer <fidrelity@users.noreply.github.com>
 2023-04-10 11:15:54 +03:00
github-actions[bot]
70435d5631 chore(docs): Generated API Reference (#3718) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-04-04 21:02:44 +03:00
olivermrbl
7738525401 fix: Merge conflicts with master 2023-02-28 11:24:46 +01:00
github-actions[bot]
89ed4cd2b1 chore(docs): Generated API Reference (#3326) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2023-02-23 17:49:38 +02:00
Shahed Nasser
8d453d35a9 docs: added details about expand, fields, and parameter types (#3325) 2023-02-23 17:12:51 +02:00
olivermrbl
e1b92e9b04 fix: Merge conflicts with master 2023-02-22 17:38:49 +01:00
github-actions[bot]
e3305188bd chore(docs): Generated API Reference (#3308) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-02-22 14:45:23 +02:00
Shahed Nasser
d1abe7cd85 chore(docs): manually generated API reference to fix load issue (#3286) 2023-02-17 15:23:20 +02:00
Patrick
8137061908 feat(oas): medusa-oas-cli as OAS build tool (#3213) 
## What

Introduce a CLI for extracting OAS from the core `medusa` package.

## Why

We need to decouple OAS tooling from documentation tooling in order to allow packages and external systems to leverage our OAS has a dependency.

## How

Introduce a new OAS workspace within packages in order to organize current and future OAS related package. Only 1 OAS package for now.

Introduce a new CLI only package to act as the main gateway for all upcoming OAS tooling. Only 1 command for now.

Update documentation tooling pertaining to OAS to use the CLI instead.

## Test

### Prerequisite
From the monorepo root:
* `yarn install`
* `yarn build`

### Documentation

#### Case - validation only - success
* Run `yarn openapi:generate --dry-run`
* Expect console output `🟢 Valid OAS` but no mention of `🔵 Exported OAS`

#### Case - validation only - invalid
* Introduce a bug by renaming `@schema Cart` to `@schema Kart` in [models/cart.ts](0adb0d9ff9/packages/medusa/src/models/cart.ts (L2))
* Run `yarn build` to update `@medusajs/medusa` package with the bug.
* Run `yarn openapi:generate --dry-run`
* Expect console output `🔴 Invalid OAS` with a stack trace of the issue.

#### Case - docs generation
* Run `yarn openapi:generate`
* Expect `docs/api/` directory to contain:
  * `admin.oas.json` (raw OAS)
  * `store.oas.json` (raw OAS)
  * `admin.oas.yaml` (sanitized OAS)
  * `store.oas.yaml` (sanitized OAS)
  * `admin/` (updated redocly split output)
  * `store/` (updated redocly split output)

### CLI

#### Case - crawl additional paths
* From a local medusa server (`medusa-starter-default`), add an `index.ts` file in `src/models/`
* In the `index.ts`, add dummy OAS JSDoc like `/** @schema Foobar */`
* From the root of the monorepo, run `yarn medusa-oas --type store --paths path-to-medusa-server/src`
* Expect a `store.oas.json` to be created at the root of the monorepo.
* The `store.oas.json` should contain an additional `Foobar` entry in `components.schemas`.
 2023-02-15 14:55:58 +00:00
github-actions[bot]
4fb22e8ba5 chore(docs): Generated API Reference (#3262) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-02-14 20:32:28 +02:00
github-actions[bot]
14b2de94e2 chore(docs): Generated API Reference (#3211) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-02-09 09:50:55 +02:00
github-actions[bot]
061a0a37fa chore(docs): Updated API Reference (#3142) 
* chore(docs): Generated API Reference

* Update admin-spec3.json

* Update admin-spec3.yaml

* Update openapi.yaml

---------

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-01-30 15:37:43 +02:00
github-actions[bot]
4e82ec0734 chore(docs): Updated API Reference (#3107) 
* chore(docs): Generated API Reference

* small fix

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-01-25 10:28:11 +02:00
Shahed Nasser
a248bf6e4f docs: added medusa-react snippets in how-to guides (#3091) 
* added medusa-react snippets

* added more code snippets

* added medusa-react snippets

* docs: added medusa-react snippets to storefront how-to

* docs: added medusa-react snippets in admin how-to

* docs: fixed incorrect link
 2023-01-23 21:04:09 +02:00
github-actions[bot]
296d6e229f chore(docs): Generated API Reference (#3061) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-01-19 10:06:17 +02:00
github-actions[bot]
853f8efdf3 chore(docs): Generated API Reference (#3021) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2023-01-13 09:27:24 +02:00
github-actions[bot]
f7e23afff2 chore(docs): Generated API Reference (#2994) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-01-11 18:08:33 +02:00
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