search

enzonotario / vitepress-openapi

Generate VitePress API Docs from OpenAPI specifications
https://vitepress-openapi.vercel.app
MIT License
54 stars 9 forks source link

chore(openapi): add createOpenApiInstance #98

Closed enzonotario closed 1 month ago

enzonotario commented 1 month ago

Description

Related issues/external references

Types of changes

vercel[bot] commented 1 month ago

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

Name Status Preview Comments Updated (UTC)
vitepress-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2024 10:28pm
coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant changes to the handling of OpenAPI specifications across various components and files. Key modifications include the restructuring of the enhanceApp method to incorporate an openapi parameter, the introduction of a new usePaths function, and the removal of the useOpenapi function in favor of a more streamlined approach. Additionally, several components have been updated to utilize the new openapi instance, enhancing their integration with OpenAPI data. Documentation has also been revised to reflect these changes and improve clarity.

Changes

File Change Summary
dev/.vitepress/theme/index.ts Updated enhanceApp method to include openapi parameter; removed useTheme logic.
dev/operations/[operationId].paths.js Replaced OpenApi import with usePaths; modified paths method to use new structure.
docs/.vitepress/theme/index.ts Updated enhanceApp method to pass openapi directly; removed previous app.provide method.
docs/example/operations/[operationId].md Removed useOpenapi import and associated variable.
docs/example/operations/[operationId].paths.js Replaced useOpenapi with usePaths; streamlined path processing logic.
docs/guide/getting-started.md Revised documentation for enhanceApp and useOpenapi to reflect new usage patterns.
docs/layouts/one-operation.md Updated example code to use usePaths instead of useOpenapi.
package.json Updated version and modified dev script for debugging; adjusted peerDependencies order.
src/components/Common/OAInfo.vue Added openapi prop; modified logic for obtaining OpenAPI instance.
src/components/Common/OAOperation.vue Updated to use openapi prop instead of spec.
src/components/Common/OAServers.vue Added openapi prop; modified initialization logic.
src/components/Common/OASpec.vue Updated to use openapi instance; modified prop passing in template.
src/components/Path/OAPath.vue Removed spec and parsedSpec props; added openapi prop.
src/components/Path/OAPaths.vue Renamed spec to openapi and removed parsedSpec.
src/components/Path/OAPathsByTags.vue Updated to use openapi instead of spec; removed parsedSpec.
src/components/Path/OAPathsSummary.vue Removed spec prop; retained paths and isDark.
src/lib/OpenApi.ts Removed transformSpec; added optional transformedSpec parameter.
src/lib/createOpenApiInstance.ts Introduced createOpenApiInstance function for OpenAPI instantiation.
src/lib/getOpenApiInstance.ts Updated function signature to include id parameter; refined instantiation logic.
src/lib/parseSpec.ts Added parseSpec function for processing OpenAPI specifications.
src/lib/transformSpec.ts Introduced transformSpec function for modifying OpenAPI specifications.
test/composables/openapi.test.ts Updated tests to use createOpenApiInstance instead of OpenApi.
src/composables/useOpenapi.ts Removed previous implementation; introduced new structure for OpenAPI handling.
src/composables/usePaths.ts Added usePaths function for managing OpenAPI paths.
src/composables/useTheme.ts Restructured theme configuration; added new interfaces for type safety.
eslint.config.js Added rules to disable "no use before define" for JavaScript and TypeScript.
src/lib/deepUnref.ts Introduced utility functions for deeply unreferencing Vue Ref types.

Possibly related PRs

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
pkg-pr-new[bot] commented 1 month ago

Open in Stackblitz

pnpm add https://pkg.pr.new/vitepress-openapi@98
pnpm add https://pkg.pr.new/vitepress-openapi@98

commit: c900554