You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/openapi.yaml
+37-12Lines changed: 37 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -19432,7 +19432,7 @@ paths:
19432
19432
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
19433
19433
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
19434
19434
<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>
19436
19436
</ul>
19437
19437
<br/>
19438
19438
<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:
19591
19591
The following qualifiers are also supported in the search term:<br>
19592
19592
<ul>
19593
19593
<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>
19598
19596
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
19599
-
<li><code>updated_at:{>=|<=}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>
19601
19599
</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/>
19602
19603
Find more examples <a href="#overview--usage-examples">here</a>.
19603
19604
example: mykey* translated:true
19604
19605
explode: true
@@ -28280,6 +28281,30 @@ components:
28280
28281
schema:
28281
28282
type: string
28282
28283
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
28283
28308
responses:
28284
28309
"200":
28285
28310
description: OK
@@ -33493,7 +33518,7 @@ components:
33493
33518
<li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>
33494
33519
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
33495
33520
<li><code>updated_at:{>=|<=}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>
33497
33522
</ul>
33498
33523
Find more examples <a href="#overview--usage-examples">here</a>.
33499
33524
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:
33607
33632
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
33608
33633
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
33609
33634
<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>
33611
33636
</ul>
33612
33637
Find more examples <a href="#overview--usage-examples">here</a>.
33613
33638
example: mykey* translated:true
@@ -33640,7 +33665,7 @@ components:
33640
33665
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
33641
33666
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
33642
33667
<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>
33644
33669
</ul>
33645
33670
Find more examples <a href="#overview--usage-examples">here</a>.
33646
33671
example: mykey* translated:true
@@ -33673,7 +33698,7 @@ components:
33673
33698
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
33674
33699
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
33675
33700
<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>
33677
33702
</ul>
33678
33703
Find more examples <a href="#overview--usage-examples">here</a>.
33679
33704
example: mykey* translated:true
@@ -33705,7 +33730,7 @@ components:
33705
33730
<li><code>tags:tag_name</code> to filter for keys with certain tags</li>
33706
33731
<li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
33707
33732
<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>
33709
33734
</ul>
33710
33735
Find more examples <a href="#overview--usage-examples">here</a>.
- @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>.
455
455
- @param "LocaleId" (optional.String) - Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
456
456
457
457
@return AffectedResources
@@ -783,7 +783,7 @@ List all keys for the given project. Alternatively you can POST requests to /sea
783
783
- @param "Branch" (optional.String) - specify the branch to use
784
784
- @param "Sort" (optional.String) - Sort by field. Can be one of: name, created_at, updated_at.
785
785
- @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:{>=|<=}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>.
787
787
- @param "LocaleId" (optional.String) - Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
0 commit comments