From bdad6a46121e9f7fccc3d305228d41c85a345283 Mon Sep 17 00:00:00 2001
From: Vincent Jacques <vincent@vincent-jacques.net>
Date: Thu, 28 Jun 2012 21:27:53 +0100
Subject: [PATCH] Create documentation and method stubs for issue #49 (legacy
 search api)

---
 doc/ReferenceOfApis.md    | 16 ++++++++++++++++
 doc/ReferenceOfClasses.md | 10 ++++++++++
 github/Github.py          |  9 +++++++++
 github/Repository.py      |  3 +++
 4 files changed, 38 insertions(+)

diff --git a/doc/ReferenceOfApis.md b/doc/ReferenceOfApis.md
index 3ee24565..ce01775c 100644
--- a/doc/ReferenceOfApis.md
+++ b/doc/ReferenceOfApis.md
@@ -57,6 +57,22 @@ API `/issues`
 =============
 * GET: `AuthenticatedUser.get_issues`
 
+API `/legacy/issues/search/:owner/:repository/:state/:keyword`
+==============================================================
+* GET: `Repository.search_issues`
+
+API `/legacy/repos/search/:keyword`
+==============================================================
+* GET: `Github.search_repos`
+
+API `/legacy/user/search/:keyword`
+==============================================================
+* GET: `Github.search_users`
+
+API `/legacy/user/email/:email`
+==============================================================
+* GET: `Github.search_user_by_email`
+
 API `/networks/:user/:repo/events`
 ==================================
 * GET: `Repository.get_network_events`
diff --git a/doc/ReferenceOfClasses.md b/doc/ReferenceOfClasses.md
index 102dd279..8e2b8aa8 100644
--- a/doc/ReferenceOfClasses.md
+++ b/doc/ReferenceOfClasses.md
@@ -20,7 +20,14 @@ Methods
 * `get_user( login )`: `NamedUser`
 * `get_organization( login )`: `Organization`
 * `get_gist( id )`: `Gist`
+    * `id`: integer
 * `get_gists()`: list of `Gist`
+* `search_repos( keyword )`: list of `Repository`
+    * `keyword`: string
+* `search_users( keyword )`: list of `NamedUser`
+    * `keyword`: string
+* `search_user_by_email( email )`: `NamedUser`
+    * `email`: string
 
 Class `GithubException`
 =======================
@@ -1191,6 +1198,9 @@ Issues
     * `sort`: string
     * `direction`: string
     * `since`: datetime
+* `search_issues( state, keyword )`: list of `Issue`
+    * `state`: "open" or "closed"
+    * `keyword`: string
 
 Issues_events
 -------------
diff --git a/github/Github.py b/github/Github.py
index 9ffb5635..ec9ff2d7 100644
--- a/github/Github.py
+++ b/github/Github.py
@@ -64,3 +64,12 @@ class Github( object ):
             headers,
             data
         )
+
+    def search_repos( self, keyword ):
+        pass
+
+    def search_users( self, keyword ):
+        pass
+
+    def search_user_by_email( self, email ):
+        pass
diff --git a/github/Repository.py b/github/Repository.py
index 16ec98dd..bb266689 100644
--- a/github/Repository.py
+++ b/github/Repository.py
@@ -1002,6 +1002,9 @@ class Repository( GithubObject.GithubObject ):
             None
         )
 
+    def search_issues( self, state, keyword ):
+        pass
+
     @property
     def _identity( self ):
         return self.owner.login + "/" + self.name