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(OAOperation): handle deprecated operations #49

Closed enzonotario closed 2 weeks ago

enzonotario commented 2 weeks ago

Fixes #43

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 18, 2024 3:00am
coderabbitai[bot] commented 2 weeks ago

Walkthrough

Los cambios realizados incluyen la deprecación del endpoint /tickets/{ticketId}/qr en la especificación OpenAPI, lo que indica que, aunque la funcionalidad sigue disponible, no se recomienda su uso. Se han implementado mejoras en varios componentes de la interfaz de usuario para mostrar visualmente el estado de deprecación, incluyendo la adición de un componente Badge y estilos condicionales. También se han actualizado los archivos de localización para incluir traducciones del término "Deprecated".

Changes

Archivos Resumen de cambios
docs/public/openapi.json Se marcó la operación GET del endpoint /tickets/{ticketId}/qr como deprecada añadiendo "deprecated": true.
src/components/Common/OAOperation.vue Se añadió un componente Badge para indicar operaciones deprecadas y se aplicó un estilo de 'línea tachada' a los encabezados de operaciones deprecadas. Se actualizaron las plantillas pathMobile y path para manejar la propiedad deprecated.
src/components/Path/OAPath.vue Se añadió la propiedad :deprecated a varios componentes en la plantilla, permitiendo que reciban información sobre el estado de deprecación.
src/components/Path/OAPathEndpoint.vue Se añadió una nueva propiedad deprecated que aplica una clase CSS de 'línea tachada' al texto del camino si es verdadero, indicando que el camino está deprecado.
src/locales/en.json Se añadió una nueva entrada "Deprecated": "Deprecated" para mejorar la localización.
src/locales/es.json Se añadió una nueva entrada "Deprecated": "Obsoleto" para proporcionar la traducción en español del término deprecado.

Assessment against linked issues

Objetivo Abordado Explicación
Soportar rutas deprecadas (#43) ✅
Renderizar de alguna manera las rutas deprecadas (#43) ✅
Recent review details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
Commits Files that changed from the base of the PR and between 4784f1f628cc2709ae9f9f7110e17a1668ff1208 and 03526b30d6496e9463f465df168ca0ec8198e2cd.
Files selected for processing (6) * docs/public/openapi.json (1 hunks) * src/components/Common/OAOperation.vue (4 hunks) * src/components/Path/OAPath.vue (3 hunks) * src/components/Path/OAPathEndpoint.vue (2 hunks) * src/locales/en.json (1 hunks) * src/locales/es.json (1 hunks)
Additional comments not posted (12)
src/locales/en.json (1)
`25-25`: **La clave de localización 'Deprecated' se ha añadido correctamente.**
src/locales/es.json (1)
`25-25`: **La clave de localización 'Deprecated' se ha añadido correctamente en español.**
src/components/Path/OAPathEndpoint.vue (2)
`21-24`: **Propiedad 'deprecated' añadida correctamente a las props.** --- `44-49`: **Aplicación condicional de la clase 'line-through' para indicar rutas obsoletas.**
src/components/Path/OAPath.vue (3)
`52-52`: **Propiedad ':deprecated' añadida correctamente para indicar operaciones obsoletas.** --- `66-66`: **Consistente adición de la propiedad ':deprecated' para las rutas móviles.** --- `129-129`: **Propiedad ':deprecated' añadida correctamente para las rutas de escritorio.**
src/components/Common/OAOperation.vue (4)
`3-3`: **Se importa el componente 'Badge' necesario para indicar operaciones obsoletas.** --- `63-82`: **Implementación correcta del componente 'Badge' y estilizado del encabezado para indicar operaciones obsoletas.** Se ha añadido un 'Badge' que se muestra cuando la operación está obsoleta y se aplica el estilo 'line-through' al resumen de la operación, mejorando la claridad para el usuario. --- `103-103`: **Propiedad ':deprecated' añadida adecuadamente al componente para las rutas móviles.** --- `258-258`: **Propiedad ':deprecated' añadida adecuadamente al componente para las rutas de escritorio.**
docs/public/openapi.json (1)
`348-348`: **La operación 'GET' se ha marcado correctamente como obsoleta en la especificación OpenAPI.**
--- 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 generate interesting stats about this repository and render them as a table.` -- `@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.
> [!TIP] >
> Early access features: enabled > > We are currently testing the following features in early access: > > - **OpenAI `o1` for code reviews**: OpenAI's new `o1` model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code. > > Note: > - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. > - - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838). > >
pkg-pr-new[bot] commented 2 weeks ago

Open in Stackblitz

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

commit: 03526b3

addshore commented 2 weeks ago

Looks good to me!

image