feat(sourceFiles): add support for new File References API #350
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #350 +/- ##
===========================================
+ Coverage 50.38% 68.33% +17.95%
===========================================
Files 277 437 +160
Lines 3688 6779 +3091
Branches 0 559 +559
===========================================
+ Hits 1858 4632 +2774
- Misses 1830 2098 +268
- Partials 0 49 +49 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
andrii-bodnar
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR introduces support for the File References API in the Crowdin SDK, enabling management of asset references attached to source files.
- Adds four new API methods: list, add, get, and delete asset references
- Introduces
AssetReferenceandAddAssetReferenceRequestmodel classes - Includes comprehensive unit tests with mocked API responses
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Crowdin.Api/SourceFiles/SourceFilesApiExecutor.cs | Implements four asset reference API methods with helper URL formatters |
| src/Crowdin.Api/SourceFiles/ISourceFilesApiExecutor.cs | Adds interface definitions for the new asset reference operations |
| src/Crowdin.Api/SourceFiles/AssetReference.cs | Defines the AssetReference model with properties like Id, Name, Url, User, CreatedAt, and MimeType |
| src/Crowdin.Api/SourceFiles/AddAssetReferenceRequest.cs | Defines the request model for adding asset references with StorageId and Name properties |
| tests/Crowdin.Api.UnitTesting/Tests/SourceFiles/AssetReferenceTests.cs | Provides unit tests for all four asset reference operations including success and failure scenarios |
| tests/Crowdin.Api.UnitTesting/Resources/SourceFiles.resx | Adds mock JSON responses for list, add, and get asset reference operations |
Files not reviewed (1)
- tests/Crowdin.Api.UnitTesting/Resources/SourceFiles.Designer.cs: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tests/Crowdin.Api.UnitTesting/Tests/SourceFiles/AssetReferenceTests.cs
Outdated
Show resolved
Hide resolved
| /// Add asset reference. Documentation: | ||
| /// <a href="https://support.crowdin.com/api/v2/#operation/api.projects.files.references.post">Crowdin API</a> | ||
| /// <a href="https://support.crowdin.com/enterprise/api/#operation/api.projects.files.references.post">Crowdin Enterprise API</a> | ||
| /// </summary> |
There was a problem hiding this comment.
Missing [PublicAPI] attribute for consistency with other public methods in this class like ListAssetReferences.
Suggested change
| /// </summary> | |
| /// </summary> | |
| [PublicAPI] |
| /// Get asset reference. Documentation: | ||
| /// <a href="https://support.crowdin.com/api/v2/#operation/api.projects.files.references.get">Crowdin API</a> | ||
| /// <a href="https://support.crowdin.com/enterprise/api/#operation/api.projects.files.references.get">Crowdin Enterprise API</a> | ||
| /// </summary> |
There was a problem hiding this comment.
Missing [PublicAPI] attribute for consistency with other public methods in this class like ListAssetReferences.
Suggested change
| /// </summary> | |
| /// </summary> | |
| [PublicAPI] |
| /// Delete asset reference. Documentation: | ||
| /// <a href="https://support.crowdin.com/api/v2/#operation/api.projects.files.references.delete">Crowdin API</a> | ||
| /// <a href="https://support.crowdin.com/enterprise/api/#operation/api.projects.files.references.delete">Crowdin Enterprise API</a> | ||
| /// </summary> |
There was a problem hiding this comment.
Missing [PublicAPI] attribute for consistency with other public methods in this class like ListAssetReferences.
Suggested change
| /// </summary> | |
| /// </summary> | |
| [PublicAPI] |
andrii-bodnar
approved these changes
Oct 28, 2025
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.
No description provided.