lib/phrase/api/keys_api.rb in phrase-2.8.2 vs lib/phrase/api/keys_api.rb in phrase-2.8.3
- old
+ new
@@ -536,11 +536,11 @@
# List all keys for the given project. Alternatively you can POST requests to /search.
# @param project_id [String] Project ID
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [Integer] :page Page number
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
# @option opts [String] :branch specify the branch to use
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
# @option opts [String] :order Order direction. Can be one of: asc, desc.
# @option opts [String] :q 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>.
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
@@ -554,11 +554,11 @@
# List all keys for the given project. Alternatively you can POST requests to /search.
# @param project_id [String] Project ID
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [Integer] :page Page number
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
# @option opts [String] :branch specify the branch to use
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
# @option opts [String] :order Order direction. Can be one of: asc, desc.
# @option opts [String] :q 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>.
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
@@ -624,11 +624,11 @@
# @param project_id [String] Project ID
# @param keys_search_parameters [KeysSearchParameters]
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [Integer] :page Page number
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
# @return [Array<TranslationKey>]
def keys_search(project_id, keys_search_parameters, opts = {})
data, _status_code, _headers = keys_search_with_http_info(project_id, keys_search_parameters, opts)
data
end
@@ -638,10 +638,10 @@
# @param project_id [String] Project ID
# @param keys_search_parameters [KeysSearchParameters]
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [Integer] :page Page number
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
# @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
def keys_search_with_http_info(project_id, keys_search_parameters, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: KeysApi.keys_search ...'
end