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(medusa-oas-cli,oas-github-ci): new options + added download of OAS in api reference #5453

Merged
merged 5 commits into from
Oct 31, 2023

Conversation

shahednasser
Copy link
Member

What

  • medusa-oas-cli: Added a new option --main-file-name that allows changing the file name of the outputted OAS, with its default being openapi.yaml
  • oas-github-ci: Added --with-full-file option that allows outputting a full OpenApi Spec file along with the split files.
  • API Reference Documentation: Added a download link that allows downloading full OAS files. These files can be imported in tools like Postman or Swagger UI

@shahednasser shahednasser requested review from a team as code owners October 23, 2023 15:53
@changeset-bot
Copy link

changeset-bot bot commented Oct 23, 2023

🦋 Changeset detected

Latest commit: d5c29da

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-oas-cli Patch
@medusajs/oas-github-ci 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

@vercel
Copy link

vercel bot commented Oct 23, 2023

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

Name Status Preview Comments Updated (UTC)
api-reference ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2023 4:23pm
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2023 4:23pm
medusa-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2023 4:23pm

@vercel vercel bot temporarily deployed to Preview – medusa-docs October 23, 2023 15:53 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-ui October 23, 2023 15:55 Inactive
@vercel vercel bot temporarily deployed to Preview – medusa-docs October 23, 2023 15:55 Inactive
@vercel vercel bot temporarily deployed to Preview – api-reference October 23, 2023 15:57 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-ui October 23, 2023 16:01 Inactive
@vercel vercel bot temporarily deployed to Preview – api-reference October 23, 2023 16:02 Inactive
@vercel vercel bot temporarily deployed to Preview – medusa-docs October 23, 2023 16:02 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-ui October 23, 2023 16:12 Inactive
@vercel vercel bot temporarily deployed to Preview – medusa-docs October 23, 2023 16:12 Inactive
@vercel vercel bot temporarily deployed to Preview – api-reference October 23, 2023 16:14 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-ui October 23, 2023 16:21 Inactive
@vercel vercel bot temporarily deployed to Preview – medusa-docs October 23, 2023 16:21 Inactive
@vercel vercel bot temporarily deployed to Preview – api-reference October 23, 2023 16:23 Inactive
@shahednasser shahednasser changed the title chore(medusa-oas-cli,oas-github-ci): new options + added download of OAS in api reference feat(medusa-oas-cli,oas-github-ci): new options + added download of OAS in api reference Oct 23, 2023
Copy link
Contributor

@olivermrbl olivermrbl left a comment

Choose a reason for hiding this comment

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

API Reference Documentation: Added a download link that allows downloading full OAS files. These files can be imported in tools like Postman or Swagger UI

I like it!

@olivermrbl olivermrbl merged commit c1b9705 into develop Oct 31, 2023
19 checks passed
@olivermrbl olivermrbl deleted the docs/oas-download branch October 31, 2023 07:05
@github-actions github-actions bot mentioned this pull request Oct 31, 2023
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