enzonotario commented 1 month ago

Description

Related issues/external references

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation improvement
Style (Change that do not affect the functionality of the code)
CI/CD (Changes to the CI/CD configuration)

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 22, 2024 1:19am

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces significant modifications to the vitepress-openapi project, primarily focusing on how the OpenAPI specification is integrated and utilized across various components and files. Key changes include the removal of the useTheme function, updates to the enhanceApp method, and the introduction of a new createOpenApiInstance function. The handling of OpenAPI instances is streamlined, with components now accepting an openapi prop instead of a spec, enhancing flexibility and simplifying the overall architecture.

Changes

File Path	Change Summary
dev/.vitepress/theme/index.ts	Removed `useTheme` imports and updated `theme.enhanceApp` to include `openapi`.
package.json	Updated version to `0.0.3-alpha.43`, modified `dev` script, reordered `peerDependencies`, added `openapi-types`, and moved `vitepress` to `devDependencies`.
src/components/Common/OAInfo.vue	Added `openapi` prop to `defineProps`, updated initialization logic to use `openapi` prop or fallback to `getOpenApiInstance`.
src/components/Common/OAOperation.vue	Imported `inject` and `getOpenApiInstance`, created `openapi` constant, updated template bindings to use `openapi`.
src/components/Common/OAServers.vue	Added `openapi` prop, updated initialization logic to check for `props.openapi`.
src/components/Common/OASpec.vue	Removed `OpenApi` and `useOpenapi` imports, updated to use `getOpenApiInstance`, modified child components to accept `openapi` prop.
src/components/Path/OAPath.vue	Removed `spec` and `parsedSpec`, added `openapi`, simplified initialization logic.
src/components/Path/OAPaths.vue	Replaced `spec` with `openapi`, removed `parsedSpec`, updated template bindings.
src/components/Path/OAPathsByTags.vue	Renamed `spec` to `openapi`, removed `parsedSpec`, updated method for obtaining OpenAPI instance.
src/components/Path/OAPathsSummary.vue	Removed `spec`, added `isDark` property.
src/composables/useOpenapi.ts	Replaced `OpenApi` import with types from `openapi-types`, updated structure to use `mainSchema`, modified return object.
src/index.ts	Updated `enhanceApp` method to accept `openapi` parameter and register it with the Vue application.
src/lib/OpenApi.ts	Removed `transformSpec`, added `transformedSpec` parameter, simplified error handling in `getParsedSpec`.
src/lib/createOpenApiInstance.ts	Introduced `createOpenApiInstance` function for transforming and parsing OpenAPI specifications.
src/lib/getOpenApiInstance.ts	Updated function signature to include new parameters and modified logic for handling `custom`.
src/lib/parseSpec.ts	Added `parseSpec` function for merging and dereferencing OpenAPI specifications with error handling.
src/lib/transformSpec.ts	Introduced `transformSpec` function for processing OpenAPI specifications.
docs/.vitepress/theme/index.ts	Updated import from `useOpenapi` to `vitepressOpenAPI`, modified `enhanceApp` method for OpenAPI integration.
docs/guide/getting-started.md	Updated documentation to reflect changes in OpenAPI integration, replacing `useOpenapi` with `vitepressOpenAPI`.
dev/operations/[operationId].paths.js	Changed import from `OpenApi` to `useOpenapi`, updated instantiation logic.
docs/example/operations/[operationId].md	Removed `useOpenapi` import and related variable initialization.
docs/example/operations/[operationId].paths.js	Simplified logic in `paths` method by directly calling `openapi.getPathsByVerbs()`.

Possibly related PRs

#72: Modifies the dev/.vitepress/theme/index.ts file to remove useTheme, impacting sidebar configuration and internationalization.
#80: Introduces OAInfo and OAServers components, relevant to updates in handling OpenAPI instances in the main PR.
#82: Groups paths by tags, connecting to changes in rendering paths and operations.
#85: Updates internationalization, related to the removal of useTheme in the main PR.
#88: Enhancements to reuse parsed specifications, relevant to the main PR's focus on OpenAPI instance handling.
#90: Implements provide/inject pattern, aligning with changes to how OpenAPI instances are provided to components.
#94: Adds example values for parameters, connecting to updates in the OASpec component.
#96: Improves scrollIntoView functionality, enhancing user experience in OpenAPI documentation.

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@97

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

commit: fc1639e

enzonotario / vitepress-openapi

feat: vitepressOpenAPI #97