search

enzonotario / vitepress-openapi

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

feat(Spec): group by tags #82

Closed enzonotario closed 1 month ago

enzonotario commented 1 month ago

Description

Allows to group paths by tags.

Related issues/external references

Closes #81

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 12, 2024 1:40pm
coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

A new Vue component named ThemeConfiguration has been added to manage theme-related configurations, allowing users to toggle settings like "Group by tags" and "Collapse paths." This component is integrated into existing pages, enhancing the user interface for managing API documentation. Additionally, several new components related to OpenAPI paths and tags have been introduced, including OAPaths, OAPathsByTags, and OAMethodBadge. The configuration for Tailwind CSS and the OpenApi module has also been updated to support these new functionalities.

Changes

File Path Change Summary
dev/.vitepress/theme/components/ThemeConfiguration.vue New component added for theme configuration with checkboxes for various settings.
dev/one-page.md Imported and rendered the new ThemeConfiguration component.
docs/.vitepress/config.mts Added alias @dev for easier imports from the dev directory.
docs/example/one-page.md Imported and rendered the new ThemeConfiguration component.
docs/tailwind.config.js Updated content array to include new paths for Tailwind CSS scanning.
src/components/Common/OAMethodBadge.vue New component added to display HTTP method badges.
src/components/Common/OASpec.vue Added groupByTags prop and modified rendering logic based on this prop.
src/components/Path/OAPathEndpoint.vue Replaced Badge component with OAMethodBadge.
src/components/Path/OAPaths.vue New component added for rendering OpenAPI paths.
src/components/Path/OAPathsByTags.vue New component added to display paths organized by tags.
src/components/Path/OAPathsSummary.vue New component added to summarize API paths.
src/components/Try/OATryItButton.vue Enhanced response handling and modified button properties.
src/components/index.ts Imported and exported new components OAPaths and OAPathsByTags.
src/components/ui/button/index.ts Modified button variants, adding a new primary variant.
src/composables/useSidebar.ts Replaced getTags function with openapi.getOperationsTags() in sidebar generation.
src/composables/useTheme.ts Introduced new configuration object and methods for managing theme settings.
src/index.ts Updated Vue I18n configuration to use the composition API mode.
src/lib/OpenApi.ts Added new functions to enhance OpenApi module capabilities related to tags and operations.
src/style.css Added new CSS classes and custom properties for theming and method badges.
tailwind.config.js Updated content array for Tailwind CSS to include additional paths.
test/composables/openapi.test.ts Updated tests to reflect changes in tag retrieval from the OpenApi instance.
test/composables/useOpenapiWithNoSpec.test.ts Updated tests to use the OpenApi instance for tag retrieval.
test/composables/useSidebar.test.ts Removed test case for the getTags method as it has been removed from the sidebar utility.

Assessment against linked issues

Objective Addressed Explanation
Group operations into tags groups (#81) ✅

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@82
pnpm add https://pkg.pr.new/vitepress-openapi@82

commit: 306a864

enzonotario commented 1 month ago

@coderabbitai review

coderabbitai[bot] commented 1 month ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.