docs/SearchApi.md in esi_client-0.8.5.0 vs docs/SearchApi.md in esi_client-1.0.1
- old
+ new
@@ -1,17 +1,17 @@
# ESIClient::SearchApi
-All URIs are relative to *https://esi.evetech.net*
+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** /v3/characters/{character_id}/search/ | Search on a string
-[**get_search**](SearchApi.md#get_search) | **GET** /v2/search/ | Search on a string
+[**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_idsearch, opts)
+> GetCharactersCharacterIdSearchOk get_characters_character_id_search(categories, character_id, search, opts)
Search on a string
Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds
@@ -25,28 +25,28 @@
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESIClient::SearchApi.new
-categories = ['categories_example'] # Array<String> | Type of entities to search for
+categories = ["categories_example"] # Array<String> | Type of entities to search for
character_id = 56 # Integer | An EVE character ID
-search = 'search_example' # String | The string to search on
+search = "search_example" # String | The string to search on
opts = {
- accept_language: 'en-us', # String | Language to use in the response
- datasource: 'tranquility', # String | The server name you would like data from
- if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
- language: 'en-us' # String | Language to use in the response, takes precedence over Accept-Language
+ datasource: "tranquility", # String | The server name you would like data from
+ language: "en-us", # String | Search locale
strict: false, # BOOLEAN | Whether the search should be a strict match
- token: 'token_example' # String | Access token to use if unable to set a header
+ token: "token_example", # String | Access token to use, if preferred over 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_idsearch, opts)
+ result = api_instance.get_characters_character_id_search(categories, character_id, search, opts)
p result
rescue ESIClient::ApiError => e
puts "Exception when calling SearchApi->get_characters_character_id_search: #{e}"
end
```
@@ -56,16 +56,16 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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 |
- **accept_language** | **String**| Language to use in the response | [optional] [default to en-us]
**datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
- **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional]
- **language** | **String**| Language to use in the response, takes precedence over Accept-Language | [optional] [default to en-us]
+ **language** | **String**| Search locale | [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 unable to set a header | [optional]
+ **token** | **String**| Access token to use, if preferred over 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
[**GetCharactersCharacterIdSearchOk**](GetCharactersCharacterIdSearchOk.md)
@@ -73,11 +73,11 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
# **get_search**
@@ -92,20 +92,20 @@
# load the gem
require 'esi_client'
api_instance = ESIClient::SearchApi.new
-categories = ['categories_example'] # Array<String> | Type of entities to search for
+categories = ["categories_example"] # Array<String> | Type of entities to search for
-search = 'search_example' # String | The string to search on
+search = "search_example" # String | The string to search on
opts = {
- accept_language: 'en-us', # String | Language to use in the response
- datasource: 'tranquility', # String | The server name you would like data from
- if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
- language: 'en-us' # String | Language to use in the response, takes precedence over Accept-Language
- strict: false # BOOLEAN | Whether the search should be a strict match
+ datasource: "tranquility", # String | The server name you would like data from
+ language: "en-us", # String | Search locale
+ 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
}
begin
#Search on a string
result = api_instance.get_search(categories, search, opts)
@@ -119,15 +119,15 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**categories** | [**Array<String>**](String.md)| Type of entities to search for |
**search** | **String**| The string to search on |
- **accept_language** | **String**| Language to use in the response | [optional] [default to en-us]
**datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
- **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional]
- **language** | **String**| Language to use in the response, takes precedence over Accept-Language | [optional] [default to en-us]
+ **language** | **String**| Search locale | [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
[**GetSearchOk**](GetSearchOk.md)
@@ -135,10 +135,10 @@
No authorization required
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json