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

24 Commits

Author SHA1 Message Date
Shahed Nasser
c900a104ce docs: fix auth routes in api reference (#8187) 2024-07-18 19:02:14 +02:00
Shahed Nasser
4c89f91caf docs: fix download button + other fixes (#8032) 
- Fix text of download button
- Small fix to styling on small devies
- Fix mobile sidebar items using incorrect base url
 2024-07-09 12:36:02 +00:00
Shahed Nasser
92dd855290 docs: restructure api-reference to allow base path (#7954) 2024-07-04 16:12:02 +00:00
Shahed Nasser
1acbcf612e docs: fix api-reference with proxy (#7952) 2024-07-04 17:10:48 +02:00
Shahed Nasser
2597990363 docs: fix details of selecting fields and relationships in api reference (#7642) 2024-06-09 15:19:51 +02:00
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
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
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
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
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
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
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
4ca70a0d0c docs: fix horizontal scroll (#5300) 2023-10-05 22:38:54 +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
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
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