docs/SearchApi.md in esi_client-1.2.0 vs docs/SearchApi.md in esi_client-1.3.0

- old
+ new

@@ -1,17 +1,17 @@ # ESIClient::SearchApi -All URIs are relative to *https://esi.tech.ccp.is/* +All URIs are relative to *https://esi.tech.ccp.is* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_characters_character_id_search**](SearchApi.md#get_characters_character_id_search) | **GET** /v2/characters/{character_id}/search/ | Search on a string [**get_search**](SearchApi.md#get_search) | **GET** /v1/search/ | Search on a string # **get_characters_character_id_search** -> GetCharactersCharacterIdSearchOk get_characters_character_id_search(categories, character_id, search, opts) +> GetCharactersCharacterIdSearchOk get_characters_character_id_search(categories, character_idsearch, opts) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds @@ -33,20 +33,20 @@ search = "search_example" # String | The string to search on opts = { datasource: "tranquility", # String | The server name you would like data from - language: "en-us", # String | Search locale + language: "en-us", # String | Language to use in the response strict: false, # BOOLEAN | Whether the search should be a strict match - token: "token_example", # String | Access token to use, if preferred over a header + token: "token_example", # String | Access token to use if unable to set a header user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent } begin #Search on a string - result = api_instance.get_characters_character_id_search(categories, character_id, search, opts) + result = api_instance.get_characters_character_id_search(categories, character_idsearch, opts) p result rescue ESIClient::ApiError => e puts "Exception when calling SearchApi->get_characters_character_id_search: #{e}" end ``` @@ -57,13 +57,13 @@ ------------- | ------------- | ------------- | ------------- **categories** | [**Array<String>**](String.md)| Type of entities to search for | **character_id** | **Integer**| An EVE character ID | **search** | **String**| The string to search on | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **language** | **String**| Search locale | [optional] [default to en-us] + **language** | **String**| Language to use in the response | [optional] [default to en-us] **strict** | **BOOLEAN**| Whether the search should be a strict match | [optional] [default to false] - **token** | **String**| Access token to use, if preferred over a header | [optional] + **token** | **String**| Access token to use if unable to set a header | [optional] **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] ### Return type @@ -98,11 +98,11 @@ search = "search_example" # String | The string to search on opts = { datasource: "tranquility", # String | The server name you would like data from - language: "en-us", # String | Search locale + language: "en-us", # String | Language to use in the response strict: false, # BOOLEAN | Whether the search should be a strict match user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent } @@ -120,10 +120,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **categories** | [**Array<String>**](String.md)| Type of entities to search for | **search** | **String**| The string to search on | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **language** | **String**| Search locale | [optional] [default to en-us] + **language** | **String**| Language to use in the response | [optional] [default to en-us] **strict** | **BOOLEAN**| Whether the search should be a strict match | [optional] [default to false] **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] ### Return type