search

enzonotario / vitepress-openapi

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

Operation Badges && i18n configuration #72

Closed enzonotario closed 1 month ago

enzonotario commented 1 month ago

Description

Allows to customize Badges to shown above Operations. Also allows to configure i18n and passing custom messages.

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 8, 2024 1:10am
coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@enzonotario has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
📥 Commits Files that changed from the base of the PR and between a4359981b2d92fa32aec58828ada2f0d260ffc78 and 8f9f9a252b3ba96de0a922ce2dc56e84d862190b.

Walkthrough

The changes in this pull request introduce enhancements to the VitePress documentation and theme configuration. A new "Customizations" section is added to the sidebar, linking to operation badges documentation. The theme configuration is updated to support internationalization (i18n) with new methods for managing locale settings and operation badges. A new Vue component, OAHeaderBadges, is introduced for displaying operation-related badges. Additionally, test cases are added for the useTheme composable to validate the new functionalities related to operation badges and i18n.

Changes

File Change Summary
docs/.vitepress/config.mts Added "Customizations" section with "Operation Badges" link in sidebar configuration.
docs/.vitepress/theme/index.ts Modified import statement for locales and added i18n configuration in enhanceApp.
docs/composables/useTheme.md Updated documentation to include new i18n and operation badges functionalities; removed setLocale.
docs/customizations/operation-badges.md Introduced documentation for customizing operation badges, including code examples.
docs/layouts/multiple-specs.md Updated operation IDs in OAOperation component examples.
src/components/Common/OAHeaderBadges.vue Added new Vue component for displaying operation badges with props for operation and deprecated status.
src/components/Common/OAOperation.vue Replaced Badge component with OAHeaderBadges for displaying operation badges.
src/composables/useTheme.ts Enhanced i18n and operation badge management; added new types and functions for configuration.
src/index.ts Updated imports and export for locales, enhanced i18n instance creation.
src/locales/en.json Added new entry for operation ID badge prefix.
src/locales/es.json Added new entry for operation ID badge prefix.
src/locales/index.ts Introduced new file to export localization data from JSON files.
test/composables/useTheme.test.ts Added test cases for operation badges and i18n configuration management.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Theme
    participant OAHeaderBadges
    participant OperationBadges

    User->>Theme: setOperationBadges(['operationId'])
    Theme->>OperationBadges: update badges
    OperationBadges-->>Theme: badges updated
    Theme->>User: confirmation

    User->>Theme: getI18nConfig()
    Theme->>User: return i18n configuration

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

commit: 8f9f9a2