Commit0793cf7

committed

Merge pull request#100 from github/search-api-timeouts

Document Search API incomplete_results attribute

2 parentsfb0ed6d +3a986bb commit0793cf7Copy full SHA for 0793cf7

File tree

+39

-0

lines changed

+39

-0

lines changed

Lines changed: 25 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,25 @@`
	`1`	`+---`
	`2`	`+kind:change`
	`3`	`+title:Understanding search results and potential timeouts`
	`4`	`+created_at:2014-04-07`
	`5`	`+author_name:izuzak`
	`6`	`+---`
	`7`	`+`
	`8`	`+Some queries are computationally expensive for our search infrastructure to`
	`9`	`+execute. To keep the[Search API](/v3/search) fast for everyone, we limit how`
	`10`	`+long any individual query can run. In rare situations when a query exceeds the`
	`11`	`+time limit, the API returns all matches that were found prior to the timeout.`
	`12`	`+`
	`13`	`+Starting today, the Search API also now[informs you when such a timeout`
	`14`	`+happens](/v3/search/#timeouts-and-incomplete-results). Reaching a timeout does`
	`15`	`+not necessarily mean that search results are incomplete. It just means that the`
	`16`	`+query was discontinued before it searched through all possible data. More`
	`17`	`+results might have been found, but also might not.`
	`18`	`+`
	`19`	`+In some cases, if you know that your search results are potentially incomplete,`
	`20`	`+you might think about the data differently. By exposing timeouts when they`
	`21`	`+happen, the API helps you better understand how to interpret the results.`
	`22`	`+`
	`23`	`+We hope this is useful as you integrate with the Search API. In the meantime,`
	`24`	`+we're working on improving search so that these timeouts occur as rarely as`
	`25`	`+possible. If you have any questions,[let us know](https://github.com/contact?form%5Bsubject%5D=Search+API).`

Lines changed: 10 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,16 @@ to make up to 5 requests per minute.`
`37`	`37`	`See the[rate limit documentation](/v3/#rate-limiting) for details on`
`38`	`38`	`determining your current rate limit status.`
`39`	`39`
	`40`	`+###Timeouts and incomplete results`
	`41`	`+`
	`42`	`+To keep the Search API fast for everyone, we limit how long any individual query`
	`43`	`+can run. For queries that[exceed the time limit](/changes/2014-04-07-understanding-search-results-and-potential-timeouts/),`
	`44`	`+the API returns the matches that were already found prior to the timeout, and`
	`45`	+the response has the`incomplete_results` property set to`true`.
	`46`	`+`
	`47`	`+Reaching a timeout does not necessarily mean that search results are incomplete.`
	`48`	`+More results might have been found, but also might not.`
	`49`	`+`
`40`	`50`	`##Search repositories`
`41`	`51`
`42`	`52`	`Find repositories via various criteria. This method returns up to 100 results[per page](/v3/#pagination).`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -769,6 +769,7 @@ def text_html(response, status, head = {})`
`769`	`769`
`770`	`770`	`ISSUE_SEARCH_V3_RESULTS={`
`771`	`771`	`"total_count"=>280,`
	`772`	`+"incomplete_results"=>false,`
`772`	`773`	`"items"=>[`
`773`	`774`	`{`
`774`	`775`	`"url"=>"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132",`
`@@ -896,6 +897,7 @@ def text_html(response, status, head = {})`
`896`	`897`
`897`	`898`	`REPO_SEARCH_V3_RESULTS={`
`898`	`899`	`"total_count"=>40,`
	`900`	`+"incomplete_results"=>false,`
`899`	`901`	`"items"=>[`
`900`	`902`	`{`
`901`	`903`	`"id"=>3081286,`
`@@ -969,6 +971,7 @@ def text_html(response, status, head = {})`
`969`	`971`
`970`	`972`	`CODE_SEARCH_V3_RESULTS={`
`971`	`973`	`"total_count"=>7,`
	`974`	`+"incomplete_results"=>false,`
`972`	`975`	`"items"=>[`
`973`	`976`	`{`
`974`	`977`	`"name"=>"classes.js",`
`@@ -1105,6 +1108,7 @@ def text_html(response, status, head = {})`
`1105`	`1108`
`1106`	`1109`	`USER_SEARCH_V3_RESULTS={`
`1107`	`1110`	`"total_count"=>12,`
	`1111`	`+"incomplete_results"=>false,`
`1108`	`1112`	`"items"=>[`
`1109`	`1113`	`{`
`1110`	`1114`	`"login"=>"mojombo",`

Comments

(0)