asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
5,418 Commits 2 Branches 0 Tags
c38f6d07c21fcb1e76347c85a0535b2fc7b9c77d
Commit Graph

47 Commits

Author SHA1 Message Date
Shahed Nasser
c38f6d07c2 docs: update design + colors (#7593) 
Update design and colors in docs to match those in Figma
 2024-06-04 07:41:24 +00:00
Shahed Nasser
98615c388b docs-util: fixes to base OAS + circular-patch redocly plugin (#7382) 
* docs-util: remove MultipleErrors schema from base OAS

* fixes to circular patch plugin

* general fixes

* change nested schemas to references
 2024-05-27 14:29:48 +02:00
Shahed Nasser
22f30f54fd docs: update api-reference project for v2 (#7307) 
* remove everything v1 and make v2 default

* move main v2 rewrites to book

* move rewrites to book + other fixes
 2024-05-16 09:02:35 +02:00
Shahed Nasser
7cb90f8e82 docs: editing and general fixes of medusa's learning resources (#7261) 
* docs: editing and general fixes of medusa's learning resources

* fix build script

* update ui dependency

* fix build

* adjust next.js steps
 2024-05-13 18:55:11 +03:00
Shahed Nasser
728c5ee53c docs: preparations for preview (#7267) 
* configured base paths + added development banner

* fix typelist site url

* added navbar and sidebar badges

* configure algolia filters

* remove AI assistant

* remove unused imports

* change navbar text and badge

* lint fixes

* fix build error

* add to api reference rewrites

* fix build error

* fix build errors in user-guide

* fix feedback component

* add parent title to pagination

* added breadcrumbs component

* remove user-guide links

* resolve todos

* fix details about authentication

* change documentation title

* lint content
 2024-05-13 11:32:52 +03:00
Shahed Nasser
1a68f4602c feat(api-ref): show schema of a tag (#7297) 2024-05-10 21:07:35 +03:00
Shahed Nasser
5d0ffe8ff4 docs: refactored versioning in api reference + modified v2 content (#7274) 2024-05-09 17:23:49 +03:00
Shahed Nasser
4fe28f5a95 chore: reorganize docs apps (#7228) 
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
 2024-05-03 17:36:38 +03:00
Shahed Nasser
7934fbdd1e docs: fix download button in API reference (#7039) 
* docs: fix download button in API reference

* remove comments
 2024-04-15 09:37:24 +02:00
Shahed Nasser
0c12d7e7d7 docs: add note about expanding nested relations (#7008) 2024-04-15 09:32:57 +02:00
github-actions[bot]
85e5478873 chore(docs): Updated API Reference (#6831) 
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-04-02 09:47:04 +00:00
github-actions[bot]
8e3e49fbbf chore(docs): Generated API Reference (#6755) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2024-03-27 18:24:22 +01:00
Shahed Nasser
e005987adf fix(medusa-oas-cli): fix tool not working in Medusa backends (#6812) 
* fix(medusa-oas-cli): fix tool not working in custom projects

* fix changeset message

---------

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>
 2024-03-26 09:33:06 +02:00
Shahed Nasser
bb87db8342 docs: prep for v2 documentation (#6710) 
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
 2024-03-18 07:47:35 +00:00
github-actions[bot]
869dc751a0 chore(docs): Updated UI Reference (#6347) 
* chore(docs): Generated UI Reference

* fixed props typing + added new alert page

* updated ui dependencies

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2024-02-12 19:46:51 +01:00
github-actions[bot]
e56c440911 chore(docs): Generated API Reference (#6346) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2024-02-08 22:05:15 +01:00
Ira
44470bf8c5 Update all curl documentation examples and references with new x-medusa-access-token header (#6326) 
## What

This is to update incorrect documentation in regards to authentication to the Admin API - raised in https://github.com/medusajs/medusa/issues/6264.

## Why

Because the current documentation has been incorrect since the September 2023 release of [v1.17.0](https://github.com/medusajs/medusa/releases/tag/v1.17.0), which had breaking changes to API token usage.

## How

Simple search and replace. I was asked to replace occurrences under `www/apps/docs/content/` but there were also additional places where I thought references should also be updated:

- `packages/medusa/src/api/`
- `www/apps/api-reference/`

Feel free to revert them as needed.

There is also some inconsistency between the format shown in examples e.g. `<API_TOKEN>` vs `{api_token}` vs `{access_token}`.

I have kept the format the same in all cases as the original, as surrounding documentation text would not have format updated as well. I suggest maybe reviewing the documentation and keeping to a consistent format e.g. `<API_TOKEN>`.

 
## Testing 

I have not tested these changes. I would assume the `packages/medusa/src/api/` changes may need more thorough testing?
 2024-02-07 08:41:38 +00:00
github-actions[bot]
bbf79169a9 chore(docs): Updated API Reference (#6220) 
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>
 2024-01-25 17:58:17 +00:00
github-actions[bot]
bc58bc8f47 chore(docs): Updated API Reference (#6041) 
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-01-10 08:14:30 +00:00
Shahed Nasser
7d650771d1 docs: generate medusa-react reference (#6004) 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
 2024-01-05 17:03:38 +02:00
Shahed Nasser
761d2e7a69 docs: update documentation websites (#5882) 
* docs: update next.js to 14.0.4

* update docusaurus to v3.0.1

* update packages dependencies

* added engines

* update lock
 2023-12-14 20:43:16 +02:00
Shahed Nasser
c0ce969cd7 docs: fixed sidebar in API reference (#5871) 2023-12-14 13:26:24 +02:00
Shahed Nasser
245e5c9a69 docs: generate documentation for UI components (#5849) 
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
 2023-12-13 16:02:41 +02:00
Shahed Nasser
547b16ead5 docs: fix code block titles (#5733) 
* docs: fix code block titles

* remove console

* fix build error
 2023-11-27 16:08:10 +00:00
github-actions[bot]
73799d4e9e chore(docs): Generated API Reference (#5662) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-11-21 10:45:38 +00:00
Bastien
b3093c3e3d feat(medusa): Add metadata to Product Category (#5599) 
* ✨ feat(migrations): add metadata column to product_category table in database to store additional information about each product category

* ✨ feat(product-category.ts): add metadata field to ProductCategory model to store additional details
📝 docs(product-category.ts): add documentation for new metadata field in ProductCategory model

* ✨ feat(product-category.ts): add metadata field to ProductCategoryInput type to support additional data

* ✨ feat(ProductCategory.ts): add optional metadata field to ProductCategory model to store additional details

* ✨ feat(product-categories): add metadata field to product categories for additional information storage
📝 docs(product-categories): add documentation for new metadata field in product categories

* ✨ feat(product-categories): add 'metadata' field to default and allowed product category fields for enhanced data tracking

* ✨ feat(product-category.ts): add metadata support to product categories
🔧 refactor(product-category.ts): import setMetadata from utils to handle metadata setting in a more efficient way

* ✨ feat(models): add metadata field to AdminPostProductCategoriesCategoryReq and AdminPostProductCategoriesReq models to store additional information

* 📝 docs(api-reference): add metadata field to ProductCategory schema in both admin and store specs
🔧 fix(api-reference): make metadata field required in ProductCategory schema to ensure data consistency

* Create nine-fishes-matter.md

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
 2023-11-16 20:37:02 +01:00
github-actions[bot]
01d4047976 chore(docs): Generated API Reference (#5601) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2023-11-10 14:27:17 +02:00
Shahed Nasser
91615f9c45 chore: improve JS Client TSDoc comments (#5582) 
* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link
 2023-11-09 12:51:17 +02:00
Shahed Nasser
2576a0fd23 docs(api-reference): added local server to list of servers (#5572) 
* docs(api-reference): added local server to list of servers

* fix publishable api key route
 2023-11-06 17:30:56 +02:00
Shahed Nasser
c1b97050ab feat(medusa-oas-cli,oas-github-ci): new options + added download of OAS in api reference (#5453) 2023-10-31 08:05:48 +01:00
Shahed Nasser
c67d490db3 chore(oas): Fix OAS related to JWT authentication (#5448) 
* chore(oas): Fix OAS related to JWT authentication

* generate openapi spec files

* remove L option in curl examples
 2023-10-23 11:48:02 +03:00
Shahed Nasser
8bc902fb0f chore(oas): update order OAS schema to include new fields (#5436) 2023-10-20 18:34:26 +03:00
github-actions[bot]
da05999f13 chore(docs): Generated API Reference (#5431) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2023-10-20 14:13:44 +03:00
Shahed Nasser
c28935b4e8 docs: update endpoints to use file-routing approach (#5397) 
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
 2023-10-19 15:56:26 +00:00
Shahed Nasser
49ed7de752 chore: fix OAS for User Login JWT (#5403) 2023-10-18 17:12:30 +03:00
Shahed Nasser
cacc443fc2 chore(oas): add note about returned fields in list product variants endpoint (#5360) 2023-10-12 14:55:13 +03:00
github-actions[bot]
c135730838 chore(docs): Generated API Reference (#5319) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2023-10-09 13:24:39 +03:00
Shahed Nasser
4ca70a0d0c docs: fix horizontal scroll (#5300) 2023-10-05 22:38:54 +03:00
Shahed Nasser
b3f75d8f21 docs: add AI Assistant (#5249) 
* added components

* added ai assistant button

* change styling

* improve AI assistant

* change to a drawer

* added command support into search

* add AiAssistant to all projects

* remove usage of Text component

* added error handling

* use recaptcha

* fix new configurations

* fix background color

* change suggested questions
 2023-10-05 11:10:44 +03:00
David Preininger
a3fe2b536f docs(medusa): Authentication overhaul (#5156) 
* implemented bearer auth

* changed naming strat

* changed session auth to not use jwt

* typo

* changed auth header prefix for admin api token auth

* fixed supporting functions to work with new session type

* removed database calls for bearer auth improving performance

* removed unused deps

* changed auth in tests

* added integration tests

* Accepted suggested change

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>

* Typo

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* more typos

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* proper formatting

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* removed endregion

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* removed startregion

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* fixed admin JWT integration test

* added more fixes to integration tests

* Update OAS

* Create fluffy-donkeys-hope.md

* created API reference for new auth

* implemented getToken in medusa-js

* Apply suggestions from code review

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

* Apply suggestions from code review

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

* deleted files which should be autogenerated

* Update fluffy-donkeys-hope.md

* JSDoc update

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>

* added missing route exports

* implemented runtime domain safety in jwt token manager

* fixed jwt manager

* lint get-token files

* Update fluffy-donkeys-hope.md

* Revert "deleted files which should be autogenerated"

This reverts commit cd5e86623b822e6a6ac37322b952143ccc493df9.

* Revert "Apply suggestions from code review"

This reverts commit f02f07ce58fd9fcc2dfc80cadbb9df2665108d65.

* Revert "created API reference for new auth"

This reverts commit c9eafbb36453f5cf8047c79e94f470cb2d023c7d.

* added api reference

* renamed header for sending api access tokens

* updated api token header in docs

* medusa-js - changed apiKey header

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-09-30 00:54:05 +03:00
github-actions[bot]
68915bee86 chore(docs): Generated API Reference (#5259) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2023-09-29 23:46:58 +03:00
Shahed Nasser
7016c8940c docs: fix design issues (#5252) 
* docs: fix design issues

* fix commands in installation tabs
 2023-09-29 17:17:24 +03:00
Shahed Nasser
11b2f1237b docs: fix irregular scrolling in code tabs (#5239) 
* docs: fix blocking scroll util

* remove unnecessary util methods
 2023-09-27 19:17:04 +03:00
Shahed Nasser
6942a907a5 docs: fix z-index across projects (#5234) 
* docs: fix z-index across projects

* remove usage of z-index in UI docs
 2023-09-27 16:38:59 +03:00
Shahed Nasser
63aea62d7a docs: improve tailwind configuration (#5215) 2023-09-26 15:08:30 +03:00
Shahed Nasser
123b3787d5 docs: general fixes for docs workspace (#5184) 2023-09-22 12:25:48 +03:00
Shahed Nasser
fa7c94b4cc docs: create docs workspace (#5174) 
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
 2023-09-21 20:57:15 +03:00