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.

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

docs: update api-reference project for v2 #7307

Merged
merged 4 commits into from
May 16, 2024
Merged

Conversation

shahednasser
Copy link
Member

@shahednasser shahednasser commented May 13, 2024

  • Make v2 the default version of api-reference
  • Set base path of V2 API reference to /v2. For example, /v2/api/admin.
  • Remove all versioning-related snippets and functionalities except for the version switcher
  • Change version switcher to only take the user to v1 API reference
  • Move rewrites to book project, making it the main routing project for paths starting with /v2.
  • Normalize environment variable names to match across projects.

Note: renaming specs-v2 directory to specs makes the number of file changes in this PR big, as that deletes v1 specs

@shahednasser shahednasser requested a review from a team as a code owner May 13, 2024 09:41
Copy link

vercel bot commented May 13, 2024

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 May 13, 2024 9:42am
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 13, 2024 9:42am
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 13, 2024 9:42am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
medusa-docs ⬜️ Ignored (Inspect) May 13, 2024 9:42am

Copy link

changeset-bot bot commented May 13, 2024

⚠️ No Changeset found

Latest commit: a2ceffd

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

@shahednasser
Copy link
Member Author

@olivermrbl can we get this one in?

@olivermrbl olivermrbl merged commit 22f30f5 into develop May 16, 2024
26 checks passed
@olivermrbl olivermrbl deleted the docs/api-ref-v2 branch May 16, 2024 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants