search

enzonotario / vitepress-openapi

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

feat(OASpec): Info && Servers #54

Closed enzonotario closed 1 week ago

enzonotario commented 2 weeks ago

Summary by CodeRabbit

vercel[bot] commented 2 weeks ago

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

Name Status Preview Comments Updated (UTC)
vitepress-theme-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 24, 2024 11:29pm
coderabbitai[bot] commented 2 weeks ago

Walkthrough

Los cambios introducen nuevos componentes de Vue para mostrar detalles de la documentación de la API y listas de servidores, así como modificaciones en la gestión del ciclo de vida de los componentes. Se implementan nuevos métodos para acceder a la información de la especificación OpenAPI y se amplía la localización en archivos JSON. Además, se realizan ajustes en las propiedades de los componentes existentes para mejorar la gestión y presentación de los datos.

Changes

Archivo Resumen de cambios
dev/criptoya-argentina/index.md Se introduce un nuevo gancho de ciclo de vida onUnmounted que modifica la configuración de profundidad de los visores JSON y esquema al desmontar el componente.
src/components/Common/OAInfo.vue Se añade un nuevo componente OAInfo que muestra información de la API, incluyendo versión, título, resumen, descripción y detalles de contacto.
src/components/Common/OAServers.vue Se añade un nuevo componente OAServers que muestra una lista de URLs de servidores y sus descripciones.
src/components/Common/OASpec.vue Se actualizan las propiedades del componente OASpec para incluir hideInfo y hideServers, permitiendo renderizar condicionalmente los componentes OAInfo y OAServers.
src/components/Try/OARequestParameterInput.vue Se modifica la propiedad modelValue para aceptar un tipo adicional Boolean, y se asegura que los valores se conviertan a cadena al renderizar.
src/components/Try/OATryWithVariables.vue Se ajusta la presentación de los datos de respuesta en el componente OACodeBlock, convirtiendo los datos en formato JSON antes de renderizarlos.
src/lib/OpenApi.ts Se actualiza la función OpenApi para acceder a los esquemas de seguridad de manera más segura, y se añaden las funciones getInfo, getExternalDocs y getServers para recuperar propiedades específicas de la especificación.
src/locales/en.json Se añaden nuevas claves de localización para "Terms of Service", "License", "Contact", "API Documentation", "External Documentation" y "Servers".
src/locales/es.json Se añaden nuevas claves de localización en español para "Terms of Service", "License", "Contact", "API Documentation", "External Documentation" y "Servers".

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](https://discord.com/invite/GsXnASn26c) 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 2 weeks ago

Open in Stackblitz

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

commit: f3caeed