Commit Graph

525 Commits

Author SHA1 Message Date
olivermrbl
6d928628a9 chore: Fix merge conflicts with master 2023-03-12 12:53:07 +01:00
Oliver Windall Juhl
ea28eea251 docs: Added upgrade guide for v1.7.12 (#3425)
* docs: Added upgrade guide for v1.7.12

* Update 1-7-12.md

* Update 1-7-12.md

---------

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-03-09 12:20:19 +01:00
Shahed Nasser
6496c20800 docs: improved generation details in migrations guide (#3396) 2023-03-06 19:58:52 +02:00
Johannes Riedmüller
0d7725d3d3 docs: fix env variable name in sendgrid (#3382)
I think this reference is wrong.
2023-03-06 10:40:20 +02:00
olivermrbl
ad99a8bd24 chore: Fix merge conflicts with master 2023-03-03 12:01:35 +01:00
github-actions[bot]
2507af68b5 chore(docs): Generated Services Reference (automated) (#3360)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-03-02 13:21:33 +01: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
github-actions[bot]
3f5b7fbe7e chore(docs): Generated Services Reference (automated) (#3309)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-02-22 14:44:52 +02:00
Frane Polić
6c04624727 chore(medusa): remove PublishableAPIKeys feature flag (#3087) 2023-02-20 21:16:08 +01:00
Shahed Nasser
d8dcc4ce9a docs: added CORS common examples (#3284)
* docs: added CORS common examples

* fix lint errors
2023-02-17 15:42:46 +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]
ef148cb9f4 chore(docs): Generated Services Reference (automated) (#3261)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-02-14 20:32:42 +02: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]
312b05ea5a chore(docs): Generated Services Reference (automated) (#3242)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-02-13 09:56:49 +02:00
github-actions[bot]
91234c14b5 chore(docs): Generated Services Reference (automated) (#3227)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-02-09 19:55:08 +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
Shahed Nasser
cf946b26fa docs: added upgrade guide for v1.7.6 (#3207) 2023-02-08 19:51:47 +01:00
olivermrbl
0a2bf7845d Merge branch 'master' into develop 2023-02-06 20:01:54 +01:00
Rafał Fortuński
63d61e31a9 docs: fix type in Spaces documentation (#3150) 2023-01-31 19:46:40 +02:00
olivermrbl
0326d6cfa3 Merge branch 'master' into develop 2023-01-31 12:10:52 +01: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
Shahed Nasser
6f058b389b docs: added information about metadata attribute (#3139)
* docs: added information about metdata fields

* docs: changed a subheader to avoid confusion

* added acronym expanding for jsonb
2023-01-30 15:24:44 +02:00
RegisHubelia
2551fe0b93 fix(medusa-plugin-sendgrid): Inject GiftCardService to eliminate undefined error (#2941) 2023-01-30 13:11:03 +01:00
Shahed Nasser
3566bccb76 docs: added publish plugin documentation (#3137) 2023-01-30 14:11:00 +02:00
Shahed Nasser
a65e115844 docs: added user guide for order editing (#3120) 2023-01-26 19:30:17 +02:00
Shahed Nasser
5af39e7beb docs: added product category events to reference (#3118) 2023-01-26 16:54:27 +02:00
Shahed Nasser
589cb18f98 docs: improved SEO of documentation (#3117)
* docs: added description to documentation pages

* docs: added more descriptions

* docs: finished improving meta description

* docs: added searchbox structured data

* docs: added breadcrumbs structured data

* docs: added how to structured data

* docs: improved 404 page

* docs: added how-to frontmatter option
2023-01-26 15:58:33 +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
Shahed Nasser
7418a0025c docs: added a fix for QueryClient error in medusa-react upgrade guide (#3089) 2023-01-23 16:23:49 +02:00
Shahed Nasser
8915abbacf docs: fix upgrade command in Medusa React upgrade guide (#3071)
* docs: fix upgrade command in Medusa React upgrade guide

* changed to an install latest command
2023-01-19 19:04:33 +02:00
Shahed Nasser
ff319cb800 docs: fixed npm/yarn blocks (#3070) 2023-01-19 18:31:40 +02:00
Shahed Nasser
b2a37109e1 docs: fixed issue with document title for Medusa React upgrade guide (#3068) 2023-01-19 18:01:48 +02:00
Shahed Nasser
7cafff14b9 docs: added migration guide for Medusa React (#3066)
* docs: added migration guide for Medusa React

* docs: fixed vale error
2023-01-19 16:59:49 +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
olivermrbl
838948c4e8 Merge branch 'master' into develop 2023-01-18 15:54:27 +01:00
Shahed Nasser
27749eae40 docs: added documentation for Medusa React (#3059)
* chore: fixed issue in typedoc plugin

* chore: updated typedoc dependencies

* docs: added Medusa React documentation

* fixed link to js-client

* fixes to package.json

* fixes to package.json

* undo changes other than docs
2023-01-18 16:42:49 +02:00
Shahed Nasser
4b5d760c96 docs: fix start command for storefront (#3058) 2023-01-18 15:57:13 +02:00
Shahed Nasser
8417757d92 docs: added a troubleshooting guide for updates (#3057) 2023-01-18 14:49:47 +02:00
olivermrbl
ab580066ae fix: Merge conflicts with master 2023-01-18 10:17:39 +01:00
Shahed Nasser
107cd4de4c docs: fixed note about custom database schema (#3049) 2023-01-17 10:38:13 +02:00
Shahed Nasser
5c6931953a docs: fixed note about database_schema option (#3037) 2023-01-16 11:22:38 +02:00
Oliver Windall Juhl
9e3beaf531 chore(feature-flags): Remove OrderEditing feature flag (#3006) 2023-01-13 11:10:09 +00: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
Shahed Nasser
dd87e62536 docs: added middleware documentation (#3000)
* docs: added a middleware documentation

* docs: fixes based on eslint
2023-01-11 20:15:17 +02:00