Skip to content

[dashboard] fix yaml highlighting and handle x-preserve-unknown-fields - #1499

Merged
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
fix-dashboard
Oct 9, 2025
Merged

[dashboard] fix yaml highlighting and handle x-preserve-unknown-fields#1499
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
fix-dashboard

Conversation

@kvaps

@kvaps Andrei Kvapil (kvaps) commented Oct 9, 2025

Copy link
Copy Markdown
Member

Signed-off-by: Andrei Kvapil kvapss@gmail.com

What this PR does

Release note

[]

Summary by CodeRabbit

  • Chores
    • Updated the OpenAPI UI container build to use a newer underlying toolkit revision, refreshing dependencies and ensuring alignment with upstream.
    • Improves build reliability and maintainability with routine configuration maintenance.
    • No user-facing features or behavior changes are expected.

Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 9, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The Docker build argument COMMIT in packages/system/dashboard/images/openapi-ui/Dockerfile was updated to a new hash. No other instructions or stages in the Dockerfile were modified.

Changes

Cohort / File(s) Summary
OpenAPI UI Docker image
packages/system/dashboard/images/openapi-ui/Dockerfile
Updated build arg: ARG COMMIT=393fd84a3b9283e93c047b744b53f1ae65465df8ARG COMMIT=a72ef72afa9bc822572c3cd0d76fb7ea872853ec; no other changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

ok-to-test

Suggested reviewers

  • lllamnyp
  • klinch0

Poem

I twitch my whiskers at a shiny new commit,
A hash hops forward—neat, precise, well-fit.
In Docker burrow, layers snug and tight,
I nibble bytes by moonlit build-night.
One hop ahead, the image brews just right. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title indicates fixes for dashboard YAML highlighting and handling of x-preserve-unknown-fields, but the actual changes only update the COMMIT build argument in the openapi-ui Dockerfile, so the title does not match the content of the pull request. Please update the pull request title to accurately describe the change, for example “[dashboard] bump openapi-ui Dockerfile COMMIT build argument,” to reflect the actual Dockerfile update.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-dashboard

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40a3ec1 and 7eb701d.

📒 Files selected for processing (1)
  • packages/system/dashboard/images/openapi-ui/Dockerfile (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello Andrei Kvapil (@kvaps), I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the dashboard's openapi-ui component by updating its core openapi-k8s-toolkit dependency. This crucial update brings in improvements for YAML syntax highlighting and ensures correct processing of OpenAPI specifications that utilize the x-preserve-unknown-fields extension, ultimately leading to a more robust and user-friendly interface.

Highlights

  • Dependency Update: The openapi-ui Dockerfile has been updated to use a newer commit of the openapi-k8s-toolkit dependency.
  • YAML Highlighting Fix: This update is expected to resolve issues with YAML syntax highlighting within the dashboard, providing a better user experience.
  • x-preserve-unknown-fields Handling: The new openapi-k8s-toolkit version includes proper handling for the x-preserve-unknown-fields OpenAPI extension, improving compatibility and correctness.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment Gemini (@gemini-code-assist) Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on Gemini (@gemini-code-assist) comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the pinned commit for the openapi-k8s-toolkit dependency in the Dockerfile. This change is intended to bring in fixes for YAML highlighting and handling of x-preserve-unknown-fields. My review includes a suggestion to add a comment next to the commit hash to improve maintainability by providing context for why this specific commit is used.

FROM node:${NODE_VERSION}-alpine AS openapi-k8s-toolkit-builder
WORKDIR /src
ARG COMMIT=393fd84a3b9283e93c047b744b53f1ae65465df8
ARG COMMIT=a72ef72afa9bc822572c3cd0d76fb7ea872853ec

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better maintainability, it's a good practice to add a comment explaining why a specific commit hash is being used. This provides context for future developers who might wonder about this dependency pin, saving them from having to investigate the history behind this commit hash. Referencing the upstream change is a great way to do this.

ARG COMMIT=a72ef72afa9bc822572c3cd0d76fb7ea872853ec # Pin for yaml highlighting and x-preserve-unknown-fields fix (cozystack/openapi-k8s-toolkit#11)

@kvaps
Andrei Kvapil (kvaps) merged commit 9ce3f8e into main Oct 9, 2025
5 of 11 checks passed
@kvaps
Andrei Kvapil (kvaps) deleted the fix-dashboard branch October 9, 2025 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant