Skip to content

rename ResourceReference to ResourceTemplateReference #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

zyfy29
Copy link

@zyfy29 zyfy29 commented Jul 24, 2025

Renamed ResourceReference to ResourceTemplateReference in source code and the kotlin sdk api documentation file

Motivation and Context

#186

How Has This Been Tested?

gradle build successful

Breaking Changes

Yes, they need to change the name in function calls as well

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

none

@Copilot Copilot AI review requested due to automatic review settings July 24, 2025 09:29
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR renames the ResourceReference class to ResourceTemplateReference to better reflect its purpose as a reference to resource or resource template definitions. The change improves code clarity by making the class name more descriptive of its actual functionality.

  • Renamed ResourceReference data class to ResourceTemplateReference in the main types file
  • Updated the polymorphic serializer to use the new class name for deserialization
  • Updated the Kotlin SDK API documentation to reflect the class name change

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types.kt Renamed the data class from ResourceReference to ResourceTemplateReference
src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types.util.kt Updated polymorphic serializer to reference the renamed class
api/kotlin-sdk.api Updated API documentation to remove old class definition and add new class definition

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