feat(api): Added support for ConcordanceSearch of TMs - partial completion of #122 #202
Conversation
This file contains 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
| * [string] $params[expressions] | ||
| * @return TranslationMemory | ||
| */ | ||
| public function concordanceSearchTM(int $projectId, array $params = []): ?TranslationMemory |
There was a problem hiding this comment.
Wrong return type. It should be Array of objects (TmConcordanceResultResource)
|
Thanks for the feedback!
I’m away for a couple weeks for the holidays but can fix that up when I’m
back.
Re the return value:
I chose TranslationMemory because I saw that value in Ray when I logged it
but I must be mistaken!
Sorry about the ru/uk thing, stupid auto-complete!
…On Mon, Dec 23, 2024 at 3:16 AM Andrii Bodnar ***@***.***> wrote:
***@***.**** commented on this pull request.
@DE-dylan-lauzon <https://github.com/DE-dylan-lauzon> thanks for the
contribution!
------------------------------
In src/CrowdinApiClient/Api/TranslationMemoryApi.php
<#202 (comment)>
:
> +
+ /**
+ * Concordance Search in TMs
+ * @link https://support.crowdin.com/developer/api/v2/#tag/Translation-Memory/operation/api.projects.tms.concordance.post API Documentation
+ * @link https://support.crowdin.com/developer/enterprise/api/v2/#tag/Translation-Memory/operation/api.projects.tms.concordance.post API Documentation Enterprise
+ *
+ * @param int $projectId
+ * @param array $params
+ * string $params[sourceLanguageId]<br>
+ * integer $params[targetLanguageId]<br>
+ * boolean $params[autoSubstitution]<br>
+ * integer $params[minRelevant]: 40-100<br>
+ * [string] $params[expressions]
+ * @return TranslationMemory
+ */
+ public function concordanceSearchTM(int $projectId, array $params = []): ?TranslationMemory
⬇️ Suggested change
- public function concordanceSearchTM(int $projectId, array $params = []): ?TranslationMemory
+ public function concordanceSearch(int $projectId, array $params = []): ?TranslationMemory
------------------------------
In src/CrowdinApiClient/Api/TranslationMemoryApi.php
<#202 (comment)>
:
> +
+ /**
+ * Concordance Search in TMs
+ * @link https://support.crowdin.com/developer/api/v2/#tag/Translation-Memory/operation/api.projects.tms.concordance.post API Documentation
+ * @link https://support.crowdin.com/developer/enterprise/api/v2/#tag/Translation-Memory/operation/api.projects.tms.concordance.post API Documentation Enterprise
+ *
+ * @param int $projectId
+ * @param array $params
+ * string $params[sourceLanguageId]<br>
+ * integer $params[targetLanguageId]<br>
+ * boolean $params[autoSubstitution]<br>
+ * integer $params[minRelevant]: 40-100<br>
+ * [string] $params[expressions]
+ * @return TranslationMemory
+ */
+ public function concordanceSearchTM(int $projectId, array $params = []): ?TranslationMemory
Wrong return type. It should be Array
of objects (TmConcordanceResultResource)
------------------------------
In tests/CrowdinApiClient/Api/TranslationMemoryApiTest.php
<#202 (comment)>
:
> @@ -303,4 +303,48 @@ public function testClear()
$this->mockRequestDelete('/tms/4/segments');
$this->crowdin->translationMemory->clear(4);
}
+
+ public function testConcordanceSearch()
+ {
+ $params = [
+ 'sourceLanguageId' => 'en',
+ 'targetLanguageId' => 'ru',
should be uk according to the response sample
—
Reply to this email directly, view it on GitHub
<#202 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BLE35TG4UPQMYBRZIWHQX6T2G7BGPAVCNFSM6AAAAABT7S3IG6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKMRQGA4DAMBWGI>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Co-authored-by: Andrii Bodnar <[email protected]>
…pi-client-php into feat-api/concordanceSearch
|
I'm not seeing TmConcordanceResultResource as an available type in the project. Does that still have to be implemented? This is what I get from the call when running against a real project:
|
|
@DE-dylan-lauzon the |
|
Hi @DE-dylan-lauzon, please let me know if there’s anything we can do to help move this PR forward. |
|
Hi Andrii!
I still have the intention to get to this! We've been trying to launch our
translation tool, and TM has become a nice-to-have, so I'll have to put
some time in on the weekend to implement the resource class! Sorry for the
delay!
Dylan
…On Mon, Feb 3, 2025 at 7:07 AM Andrii Bodnar ***@***.***> wrote:
Hi @DE-dylan-lauzon <https://github.com/DE-dylan-lauzon>, please let me
know if there’s anything we can do to help move this PR forward.
—
Reply to this email directly, view it on GitHub
<#202 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BLE35TFX5LGLJIQNMGBPQLT2N5LW7AVCNFSM6AAAAABT7S3IG6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMZQG43DEOJWHA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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.
Added support for ConcordanceSearch endpoint of TMs - partial completion of issue #122