chore!:update config kind from plural to singular#2737
Open
Yuan325 wants to merge 1 commit intoremove-deprecationfrom
Open
chore!:update config kind from plural to singular#2737Yuan325 wants to merge 1 commit intoremove-deprecationfrom
kind from plural to singular#2737Yuan325 wants to merge 1 commit intoremove-deprecationfrom
Conversation
Yuan325
changed the title
kind from plural to singular
Contributor
Link Resolution NoteLocal links and directory changes work differently on GitHub than on the docsite. You must ensure fixes pass the GitHub check and also work with Summary
Errors per inputErrors in DEVELOPER.md
Errors in docs/en/resources/sources/alloydb-admin.mdErrors in docs/en/resources/sources/bigquery.mdErrors in docs/en/resources/sources/cloud-healthcare.mdErrors in docs/en/resources/sources/cloud-logging-admin.mdErrors in docs/en/resources/sources/cloud-monitoring.mdErrors in docs/en/resources/sources/cloud-sql-mysql.mdErrors in docs/en/resources/sources/cloud-sql-pg.mdErrors in docs/en/resources/sources/dataplex.mdErrors in docs/en/resources/sources/dataproc.mdErrors in docs/en/resources/sources/redis.mdErrors in docs/en/resources/sources/serverless-spark.mdErrors in docs/en/resources/sources/spanner.mdErrors in docs/en/resources/sources/valkey.mdErrors in docs/en/resources/tools/alloydb/alloydb-create-cluster.md
Errors in docs/en/resources/tools/alloydb/alloydb-create-instance.md
Errors in docs/en/resources/tools/alloydb/alloydb-create-user.md
Errors in docs/en/resources/tools/bigquery/bigquery-sql.mdErrors in docs/en/resources/tools/bigtable/bigtable-sql.mdErrors in docs/en/resources/tools/cloudsql/cloudsqlcloneinstance.mdErrors in docs/en/resources/tools/cloudsql/cloudsqlrestorebackup.mdErrors in docs/en/resources/tools/spanner/spanner-sql.mdErrors in docs/en/samples/alloydb/mcp_quickstart.md |
Contributor
Contributor
Summary of ChangesHello, 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 introduces a significant refactoring of configuration definitions, moving from plural to singular naming conventions for 'kind' fields. This change enhances consistency and readability across configuration files, internal parsing logic, and user-facing documentation. The update ensures that the system uniformly recognizes and processes configuration types, simplifying future development and maintenance efforts. Highlights
Changelog
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a breaking change by updating the configuration kind values from plural to singular across the entire project. The changes are extensive, affecting documentation, tests, and configuration parsing logic. The implementation correctly handles backward compatibility for the v1 configuration format. My main feedback is a suggestion to refactor a block of if statements into a switch statement for improved code clarity and maintainability in cmd/internal/tools_file.go.
Comment on lines
127
to
+147
| if key == "authSources" { | ||
| key = "authServices" | ||
| } | ||
| if key == "sources" { | ||
| key = "source" | ||
| } | ||
| if key == "authServices" { | ||
| key = "authService" | ||
| } | ||
| if key == "embeddingModels" { | ||
| key = "embeddingModel" | ||
| } | ||
| if key == "tools" { | ||
| key = "tool" | ||
| } | ||
| if key == "toolsets" { | ||
| key = "toolset" | ||
| } | ||
| if key == "prompts" { | ||
| key = "prompt" | ||
| } |
Contributor
There was a problem hiding this comment.
This series of if statements for converting old configuration keys to new ones could be simplified and made more readable by using a switch statement. This would make the logic clearer, especially the chained conversion of authSources to authService, and improve future maintainability.
switch key {
case "authSources", "authServices":
key = "authService"
case "sources":
key = "source"
case "embeddingModels":
key = "embeddingModel"
case "tools":
key = "tool"
case "toolsets":
key = "toolset"
case "prompts":
key = "prompt"
}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update all the
kindvalue from plural to singular. This breaking change only affect users that are currently using the config file v2 format.Config file with the v1 format will still be compatible since we manually convert the config file to the right format under the hood.