update key in header

[vncloudsco]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @vncloudsco, I'm Gemini Code Assist¹! 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 refines the API key authentication process by standardizing the header name from 'X-API-Key' to 'key'. This change simplifies the integration experience for external services and ensures that all user-facing messages and internal documentation accurately reflect the updated header requirement.

Highlights

• API Key Header Name Change: The API key header name has been updated from 'X-API-Key' to a more concise 'key' for API authentication.
• Documentation and Error Message Consistency: All internal references, docstrings, and error messages related to the API key header have been adjusted to reflect the new 'key' name, ensuring consistency across the authentication module.

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-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-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]

Code Review

This pull request changes the API key header from X-API-Key to key. This is a breaking change for any clients using API key authentication. My main feedback is that key is a very generic header name and it's generally better to use a more descriptive and conventional name like X-API-Key or a custom one like OVPanel-API-Key. I've left a specific suggestion to revert this change or choose a more descriptive name. Since this is a breaking change, it would be good to add a description to the pull request explaining the change and the reason for it.

[gemini-code-assist]

The API key header name has been changed from X-API-Key to key. While the X- prefix for custom headers is being deprecated, X-API-Key is a widely understood de-facto standard. Using a generic name like key is not recommended as it is not descriptive and could potentially conflict with other headers. It is better to use a more specific name. If you want to avoid the X- prefix, consider a name like OVPanel-API-Key. Reverting to X-API-Key would be the clearest and most conventional choice.

Suggested change

	api_key_header = APIKeyHeader(name="key", auto_error=False)
	api_key_header = APIKeyHeader(name="X-API-Key", auto_error=False)