fix(medusa-oas-cli): fix tool not working in Medusa backends #6812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Ignored Deployments
|
🦋 Changeset detectedLatest commit: 8c4a583 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
/snapshot-this |
🚀 A snapshot release has been made for this PRTest the snapshots by updating your yarn add @medusajs/core-flows@0.1.0-snapshot-20240325085803yarn add @medusajs/event-bus-redis@1.8.12-snapshot-20240325085803yarn add @medusajs/client-types@0.2.11-snapshot-20240325085803yarn add @medusajs/link-modules@0.2.10-snapshot-20240325085803yarn add @medusajs/medusa@1.21.0-snapshot-20240325085803yarn add medusa-test-utils@1.1.43-snapshot-20240325085803yarn add @medusajs/modules-sdk@1.12.10-snapshot-20240325085803yarn add @medusajs/medusa-oas-cli@0.3.2-snapshot-20240325085803yarn add @medusajs/orchestration@0.5.6-snapshot-20240325085803yarn add @medusajs/product@0.4.0-snapshot-20240325085803yarn add @medusajs/promotion@0.0.3-snapshot-20240325085803yarn add @medusajs/types@1.12.0-snapshot-20240325085803yarn add @medusajs/user@0.0.3-snapshot-20240325085803yarn add @medusajs/utils@1.11.8-snapshot-20240325085803yarn add @medusajs/workflows-sdk@0.1.5-snapshot-20240325085803
|
olivermrbl
approved these changes
Mar 25, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This PR fixes the error shared in issue #6810 due to changing the location of the OAS.
Why
Since we changed the location of the OAS to be in the
docs-util/oas-outputdirectory, the OAS yaml files are no longer shipped with Medusa. This caused an error when trying to run the tool in a separate Medusa backend.Considering moving forward with V2 we won't include the OAS inline with endpoints as well, the approach proposed by this PR is to load the OAS file from the public API reference rather than the local files.
The only downside to this is that developers will always get the OAS of the latest Medusa version rather than the current version they're running. If we find this to be an issue, we can revisit this later and see how we can address it.
This PR also adds a
--localoption to the OAS CLI tool so that we can still generate OAS files in the monorepo for our references.Additional Changes
--localoption where necessarydownloadendpoint in the API reference project to accept a version query parameters (for v1/v2).