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
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
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
