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

feat(oas): include /admin and /store in paths URLs #3314

Merged
merged 3 commits into from
Feb 22, 2023
Merged

Conversation

patrick-medusajs
Copy link
Contributor

@patrick-medusajs patrick-medusajs commented Feb 22, 2023

What

Include /admin and /store in OAS paths URLs

Why

Allow for generating a combined OAS that include routes for both "admin" and "store" endpoint.

Fix potential issues with code generator where routes are not prefixed with "admin" and "store" leading to 404 errors.

Test

  • Run yarn build
  • Run yarn openapi:generate
  • Run yarn redocly preview-docs docs/api/admin/openapi.yaml --config=./docs-util/redocly/config.yaml
  • Expect paths to be prefixed with /admin.
  • Run yarn redocly preview-docs docs/api/store/openapi.yaml --config=./docs-util/redocly/config.yaml
  • Expect paths to be prefixed with /store.

@patrick-medusajs patrick-medusajs self-assigned this Feb 22, 2023
@changeset-bot
Copy link

changeset-bot bot commented Feb 22, 2023

🦋 Changeset detected

Latest commit: b7bce05

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@medusajs/medusa Patch
@medusajs/inventory Patch

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

@patrick-medusajs patrick-medusajs marked this pull request as ready for review February 22, 2023 14:30
@patrick-medusajs patrick-medusajs requested a review from a team as a code owner February 22, 2023 14:30
Copy link
Member

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

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

LGTM

@kodiakhq kodiakhq bot merged commit 287c829 into develop Feb 22, 2023
@kodiakhq kodiakhq bot deleted the feat/oas-path-url branch February 22, 2023 15:43
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