Skip to content

Commit

Permalink
Deploying from phrase/openapi@f0dd1ebe
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Nov 28, 2023
1 parent 233f3b4 commit 5b41ac8
Show file tree
Hide file tree
Showing 206 changed files with 248 additions and 230 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Phrase Strings API Reference

- API version: 2.0.0

- Build date: 2023-11-13T16:14:58.908446Z[Etc/UTC]
- Build date: 2023-11-28T08:47:49.181415Z[Etc/UTC]

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.

Expand Down
58 changes: 38 additions & 20 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -744,8 +744,10 @@ info:

<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>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>
Expand Down Expand Up @@ -833,8 +835,10 @@ info:

<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>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>
Expand Down Expand Up @@ -916,8 +920,10 @@ info:

<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 - whitespaces need to be prefixed with a backspace ("\")</li>
<li><code>tags:tag_name</code> to filter for keys with certain tags</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>
Expand Down Expand Up @@ -1013,8 +1019,10 @@ info:

<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 - whitespaces need to be prefixed with a backspace ("\")</li>
<li><code>tags:tag_name</code> to filter for keys with certain tags</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>
Expand Down Expand Up @@ -1108,8 +1116,10 @@ info:

<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 - whitespaces need to be prefixed with a backspace ("\")</li>
<li><code>tags:tag_name</code> to filter for keys with certain tags</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>
Expand Down Expand Up @@ -1196,8 +1206,10 @@ info:

<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 - whitespaces need to be prefixed with a backspace ("\")</li>
<li><code>tags:tag_name</code> to filter for keys with certain tags</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>
Expand Down Expand Up @@ -1283,8 +1295,10 @@ info:

<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 - whitespaces need to be prefixed with a backspace ("\")</li>
<li><code>tags:tag_name</code> to filter for keys with certain tags</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>
Expand Down Expand Up @@ -19434,10 +19448,12 @@ paths:
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>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>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>.
Expand Down Expand Up @@ -31694,10 +31710,12 @@ components:
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>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>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>.
Expand Down
4 changes: 2 additions & 2 deletions docs/KeysApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ public class Example {
String branch = "my-feature-branch"; // String | specify the branch to use
String sort = "updated_at"; // String | Sort by field. Can be one of: name, created_at, updated_at.
String order = "desc"; // String | Order direction. Can be one of: asc, desc.
String q = "mykey* translated:true"; // 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> Find more examples <a href=\"#overview--usage-examples\">here</a>.
String q = "mykey* translated:true"; // 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>.
String localeId = "abcd1234abcd1234abcd1234abcd1234"; // String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
try {
List<TranslationKey> result = apiInstance.keysList(projectId, xPhraseAppOTP, page, perPage, branch, sort, order, q, localeId);
Expand All @@ -662,7 +662,7 @@ Name | Type | Description | Notes
**branch** | **String**| specify the branch to use | [optional]
**sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name,...&lt;/code&gt; for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name,...&lt;/code&gt; to filter for keys with certain comma-seperated list of tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;uploads:upload_id,...&lt;/code&gt; to filter for keys with certain comma-seperated list of uploads&lt;/li&gt; &lt;li&gt;&lt;code&gt;job:{true|false}&lt;/code&gt; to filter for keys mentioned in an active job&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&amp;gt;&#x3D;|&amp;lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
**localeId** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]

### Return type
Expand Down
Loading

0 comments on commit 5b41ac8

Please sign in to comment.