docs/KeysApi.md in phrase-2.8.2 vs docs/KeysApi.md in phrase-2.8.3
- old
+ new
@@ -495,11 +495,11 @@
api_instance = Phrase::KeysApi.new
project_id = 'project_id_example' # String | Project ID
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
page: 1, # Integer | Page number
- per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
branch: 'my-feature-branch', # String | specify the branch to use
sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
order: 'desc', # String | Order direction. Can be one of: asc, desc.
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>.
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
@@ -520,11 +520,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**project_id** | **String**| Project ID |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
**page** | **Integer**| Page number | [optional]
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
**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).<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>. | [optional]
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
@@ -571,11 +571,11 @@
project_id = 'project_id_example' # String | Project ID
keys_search_parameters = Phrase::KeysSearchParameters.new # KeysSearchParameters |
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
page: 1, # Integer | Page number
- per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
+ per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
}
begin
#Search keys
result = api_instance.keys_search(project_id, keys_search_parameters, opts)
@@ -592,10 +592,10 @@
------------- | ------------- | ------------- | -------------
**project_id** | **String**| Project ID |
**keys_search_parameters** | [**KeysSearchParameters**](KeysSearchParameters.md)| |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
**page** | **Integer**| Page number | [optional]
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
### Return type
Response<([**Array<TranslationKey>**](TranslationKey.md))>