feat: Add File References API support#241
Closed
7uyash wants to merge 3 commits intocrowdin:masterfrom
Closed
Conversation
EXAMPLES.md
Outdated
| print_r($tbxFile->getData()); | ||
| ``` | ||
|
|
||
| ## Manage file references |
Member
There was a problem hiding this comment.
File references are not something so common, there is no need in the dedicated example
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive support for managing file references in the Crowdin API client, enabling users to list, get, add, and delete file references for project files.
- Introduces the
FileReferencemodel class with all necessary getters and setters - Adds four API methods to
FileApifor complete file reference CRUD operations - Includes comprehensive test coverage for both the model and API methods
- Updates documentation with practical examples for using the new functionality
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/CrowdinApiClient/Model/FileReference.php | New model class representing a file reference with properties like id, projectId, fileId, name, type, url, and timestamps |
| src/CrowdinApiClient/Api/FileApi.php | Adds four new methods: listReferences, getReference, addReference, and deleteReference for managing file references |
| tests/CrowdinApiClient/Model/FileReferenceTest.php | Comprehensive unit tests for the FileReference model covering constructor initialization and setter methods |
| tests/CrowdinApiClient/Api/FileApiTest.php | Integration tests for all four file reference API methods with proper mock responses |
| EXAMPLES.md | Adds a complete example section demonstrating how to use the new file reference management features |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Fixes #240
This commit implements support for the new Crowdin API file reference endpoints, allowing users to manage asset file references in their Source Files workflow.
Added:
API Endpoints Supported:
Features:
Usage: