Skip to content

Commit 1c0da28

Browse files
author
Phrase
committed
1 parent 96a05f7 commit 1c0da28

13 files changed

+51
-26
lines changed

api/openapi.yaml

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19432,7 +19432,7 @@ paths:
1943219432
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
1943319433
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
1943419434
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
19435-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
19435+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
1943619436
</ul>
1943719437
<br/>
1943819438
<p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p>
@@ -19591,14 +19591,15 @@ paths:
1959119591
The following qualifiers are also supported in the search term:<br>
1959219592
<ul>
1959319593
<li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>
19594-
<li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>
19595-
<li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li>
19596-
<li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li>
19597-
<li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>
19594+
<li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>
19595+
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
1959819596
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
19599-
<li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li>
19600-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
19597+
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
19598+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
1960119599
</ul>
19600+
<br/>
19601+
<p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p>
19602+
<br/>
1960219603
Find more examples <a href="#overview--usage-examples">here</a>.
1960319604
example: mykey* translated:true
1960419605
explode: true
@@ -28280,6 +28281,30 @@ components:
2828028281
schema:
2828128282
type: string
2828228283
style: form
28284+
q:
28285+
description: |
28286+
Specify a query to do broad search for keys by name (including wildcards).<br><br>
28287+
The following qualifiers are also supported in the search term:<br>
28288+
<ul>
28289+
<li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>
28290+
<li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>
28291+
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
28292+
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
28293+
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
28294+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
28295+
</ul>
28296+
<br/>
28297+
<p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p>
28298+
<br/>
28299+
Find more examples <a href="#overview--usage-examples">here</a>.
28300+
example: mykey* translated:true
28301+
explode: true
28302+
in: query
28303+
name: q
28304+
required: false
28305+
schema:
28306+
type: string
28307+
style: form
2828328308
responses:
2828428309
"200":
2828528310
description: OK
@@ -33493,7 +33518,7 @@ components:
3349333518
<li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>
3349433519
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
3349533520
<li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li>
33496-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
33521+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
3349733522
</ul>
3349833523
Find more examples <a href="#overview--usage-examples">here</a>.
3349933524
Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.
@@ -33607,7 +33632,7 @@ components:
3360733632
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
3360833633
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
3360933634
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
33610-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
33635+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
3361133636
</ul>
3361233637
Find more examples <a href="#overview--usage-examples">here</a>.
3361333638
example: mykey* translated:true
@@ -33640,7 +33665,7 @@ components:
3364033665
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
3364133666
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
3364233667
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
33643-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
33668+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
3364433669
</ul>
3364533670
Find more examples <a href="#overview--usage-examples">here</a>.
3364633671
example: mykey* translated:true
@@ -33673,7 +33698,7 @@ components:
3367333698
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
3367433699
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
3367533700
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
33676-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
33701+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
3367733702
</ul>
3367833703
Find more examples <a href="#overview--usage-examples">here</a>.
3367933704
example: mykey* translated:true
@@ -33705,7 +33730,7 @@ components:
3370533730
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
3370633731
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
3370733732
<li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
33708-
<li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
33733+
<li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
3370933734
</ul>
3371033735
Find more examples <a href="#overview--usage-examples">here</a>.
3371133736
example: mykey* translated:true

api_keys.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ Delete all keys matching query. Same constraints as list. Please limit the numbe
451451
- @param optional nil or *KeysDeleteCollectionOpts - Optional Parameters:
452452
- @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
453453
- @param "Branch" (optional.String) - specify the branch to use
454-
- @param "Q" (optional.String) - Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
454+
- @param "Q" (optional.String) - Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
455455
- @param "LocaleId" (optional.String) - Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
456456
457457
@return AffectedResources
@@ -783,7 +783,7 @@ List all keys for the given project. Alternatively you can POST requests to /sea
783783
- @param "Branch" (optional.String) - specify the branch to use
784784
- @param "Sort" (optional.String) - Sort by field. Can be one of: name, created_at, updated_at.
785785
- @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.
786-
- @param "Q" (optional.String) - Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li> <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li> <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
786+
- @param "Q" (optional.String) - Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
787787
- @param "LocaleId" (optional.String) - Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
788788
789789
@return []TranslationKey

0 commit comments

Comments
 (0)