Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docs across projects following publishable API key change in store routes #9098

Merged
merged 4 commits into from
Sep 16, 2024
Merged

docs: update docs across projects following publishable API key change in store routes #9098

merged 4 commits into from
Sep 16, 2024

Conversation

shahednasser
Copy link
Member

  • Add a storefront guide explaining the publishable API key requirement, how to create one, and how to use it in your requests
  • Add the PAK header to all requests to store API routes across docs
  • Change all custom routes in the main docs to not be under /store to avoid friction
  • Update the PAK section in the API reference to indicate it's a must.
  • Remove the API testing tool across docs as it requires the PAK to work / unusable for custom routes. We can look into it in the future
  • Update the Storefront Development guide in the main docs to mention passing the PAK in the header of requests.

@shahednasser shahednasser requested a review from a team as a code owner September 11, 2024 11:11
@vercel Vercel
Copy link

vercel bot commented Sep 11, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-reference 🔄 Building (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 1:32pm
api-reference-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 1:32pm
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 1:32pm
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 1:32pm
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 1:32pm
resources-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 1:32pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Sep 16, 2024 1:32pm

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 11, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 45ac7ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

riqwan
riqwan approved these changes Sep 11, 2024
View reviewed changes
Copy link
Contributor

@riqwan riqwan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥇

www/apps/resources/app/storefront-development/publishable-api-keys/page.mdx Outdated Show resolved Hide resolved
@kodiakhq kodiakhq bot removed the automerge label Sep 16, 2024
@kodiakhq kodiakhq
Copy link
Contributor

kodiakhq bot commented Sep 16, 2024

This PR currently has a merge conflict. Please resolve this and then re-add the automerge label.

@shahednasser shahednasser merged commit 58f06be into develop Sep 16, 2024
32 checks passed
@shahednasser shahednasser deleted the docs/pak-updates branch September 16, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@riqwan riqwan riqwan approved these changes

@olivermrbl olivermrbl olivermrbl approved these changes

Assignees
No one assigned
Labels
team: medusa type: docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shahednasser @riqwan @olivermrbl