Skip to content

Commit e12e2d5

Browse files
bradchoatepengwynn
authored andcommitted
Update content/v3/search.md
Updated Email search section to be explicit about the format expected for the "@" character (URL-encoded as %40 will not match). Also noted that the API only matches for public email addresses.
1 parent baf123f commit e12e2d5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

content/v3/search.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ keyword
6666
## Email search
6767

6868
This API call is added for compatibility reasons only. There's no guarantee
69-
that full email searches will always be available.
69+
that full email searches will always be available. The `@` character in the
70+
address must be left unencoded. Searches only against public email addresses
71+
(as configured on the user's GitHub profile).
7072

7173
GET /legacy/user/email/:email
7274

0 commit comments

Comments
 (0)