Skip to content

Commit b40f99d

Browse files
jasonrudolphjasonrudolph
committed
ANN: Search API Becomes an Official Part of API v3
1 parent 0656901 commit b40f99d

File tree

12 files changed

+519
-240
lines changed

12 files changed

+519
-240
lines changed

‎changes.atom‎

Lines changed: 66 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,47 @@
22
<feed xmlns="http://www.w3.org/2005/Atom">
33
<id>http://developer.github.com/</id>
44
<title>GitHub API Changes</title>
5-
<updated>2013-10-18T04:00:00Z</updated>
5+
<updated>2013-10-29T04:00:00Z</updated>
66
<link rel="alternate" href="http://developer.github.com/" />
77
<link rel="self" href="http://developer.github.com/changes.atom" />
88
<author>
99
<name>technoweenie</name>
1010
<uri>https://github.com/technoweenie</uri>
1111
</author>
12+
<entry>
13+
<id>tag:developer.github.com,2013-10-29:/changes/2013-10-29-search-api-becomes-an-official-part-of-github-api-v3/</id>
14+
<title type="html">Search API Becomes an Official Part of API v3</title>
15+
<published>2013-10-29T04:00:00Z</published>
16+
<updated>2013-10-29T04:00:00Z</updated>
17+
<author>
18+
<name>jasonrudolph</name>
19+
<uri>https://github.com/technoweenie</uri>
20+
</author>
21+
<link rel="alternate" href="http://developer.github.com/changes/2013-10-29-search-api-becomes-an-official-part-of-github-api-v3/" />
22+
<content type="html">&lt;p&gt;We’re excited to announce that the &lt;a href="/v3/search"&gt;new Search API&lt;/a&gt; has graduated from &lt;a href="/changes/2013-07-19-preview-the-new-search-api/#preview-period"&gt;preview mode&lt;/a&gt;.
23+
As of today, the Search API is an official part of &lt;a href="/v3"&gt;GitHub API v3&lt;/a&gt;.
24+
As such, the Search API is now stable and suitable for production use.&lt;/p&gt;
25+
26+
&lt;h3 id="preview-media-type-no-longer-needed"&gt;Preview Media Type No Longer Needed&lt;/h3&gt;
27+
28+
&lt;p&gt;If you used the Search API during the preview period, you needed to provide a custom media type in the &lt;code&gt;Accept&lt;/code&gt; header:&lt;/p&gt;
29+
30+
&lt;pre&gt;&lt;code&gt;application/vnd.github.preview+json
31+
&lt;/code&gt;&lt;/pre&gt;
32+
33+
&lt;p&gt;Now that the preview period has ended, you no longer need to pass this custom media type.&lt;/p&gt;
34+
35+
&lt;p&gt;Instead, we &lt;a href="/v3/media"&gt;recommend&lt;/a&gt; that you specify &lt;code&gt;v3&lt;/code&gt; as the version in the &lt;code&gt;Accept&lt;/code&gt; header:&lt;/p&gt;
36+
37+
&lt;pre&gt;&lt;code&gt;application/vnd.github.v3+json
38+
&lt;/code&gt;&lt;/pre&gt;
39+
40+
&lt;h3 id="onward"&gt;Onward!&lt;/h3&gt;
41+
42+
&lt;p&gt;Thanks again to everyone that tried out the Search API during the preview period.&lt;/p&gt;
43+
44+
&lt;p&gt;We can’t wait to see what you build!&lt;/p&gt;</content>
45+
</entry>
1246
<entry>
1347
<id>tag:developer.github.com,2013-10-18:/changes/2013-10-18-new-code-search-requirements/</id>
1448
<title type="html">New Validation Rule for Beta Code Search API</title>
@@ -526,6 +560,23 @@ curl -u defunkt https://api.github.com/feeds
526560
&lt;/pre&gt;
527561

528562
&lt;p&gt;If you have any questions or feedback, &lt;a href="https://github.com/contact?form%5Bsubject%5D=Feeds%20API"&gt;please drop us a line&lt;/a&gt;.&lt;/p&gt;</content>
563+
</entry>
564+
<entry>
565+
<id>tag:developer.github.com,2013-05-06:/changes/2013-05-06-create-update-delete-individual-files/</id>
566+
<title type="html">Create, update, and delete individual files</title>
567+
<published>2013-05-06T04:00:00Z</published>
568+
<updated>2013-05-06T04:00:00Z</updated>
569+
<author>
570+
<name>ymendel</name>
571+
<uri>https://github.com/technoweenie</uri>
572+
</author>
573+
<link rel="alternate" href="http://developer.github.com/changes/2013-05-06-create-update-delete-individual-files/" />
574+
<content type="html">&lt;p&gt;We’re following in the footsteps of GitHub.com’s ability to &lt;a href="https://github.com/blog/143-inline-file-editing"&gt;edit&lt;/a&gt; and
575+
&lt;a href="https://github.com/blog/1327-creating-files-on-github"&gt;create&lt;/a&gt; files in your web browser. Starting today, the
576+
&lt;a href="/v3/repos/contents/"&gt;Repository Contents API&lt;/a&gt; will let you easily &lt;a href="/v3/repos/contents/#create-a-file"&gt;create&lt;/a&gt;, &lt;a href="/v3/repos/contents/#update-a-file"&gt;update&lt;/a&gt;, and even
577+
&lt;a href="/v3/repos/contents/#delete-a-file"&gt;delete&lt;/a&gt; individual files.&lt;/p&gt;
578+
579+
&lt;p&gt;Happy editing!&lt;/p&gt;</content>
529580
</entry>
530581
<entry>
531582
<id>tag:developer.github.com,2013-05-06:/changes/2013-05-06-repository-stats/</id>
@@ -552,21 +603,24 @@ but we can’t wait to see what others can do with this information.&lt;/p&gt;
552603
&lt;/ul&gt;&lt;p&gt;Enjoy!&lt;/p&gt;</content>
553604
</entry>
554605
<entry>
555-
<id>tag:developer.github.com,2013-05-06:/changes/2013-05-06-create-update-delete-individual-files/</id>
556-
<title type="html">Create, update, and delete individual files</title>
557-
<published>2013-05-06T04:00:00Z</published>
558-
<updated>2013-05-06T04:00:00Z</updated>
606+
<id>tag:developer.github.com,2013-04-30:/changes/2013-04-30-statuses-for-branches-and-tags/</id>
607+
<title type="html">Commit Statuses Now Available for Branches and Tags</title>
608+
<published>2013-04-30T04:00:00Z</published>
609+
<updated>2013-04-30T04:00:00Z</updated>
559610
<author>
560-
<name>ymendel</name>
611+
<name>foca</name>
561612
<uri>https://github.com/technoweenie</uri>
562613
</author>
563-
<link rel="alternate" href="http://developer.github.com/changes/2013-05-06-create-update-delete-individual-files/" />
564-
<content type="html">&lt;p&gt;We’re following in the footsteps of GitHub.com’s ability to &lt;a href="https://github.com/blog/143-inline-file-editing"&gt;edit&lt;/a&gt; and
565-
&lt;a href="https://github.com/blog/1327-creating-files-on-github"&gt;create&lt;/a&gt; files in your web browser. Starting today, the
566-
&lt;a href="/v3/repos/contents/"&gt;Repository Contents API&lt;/a&gt; will let you easily &lt;a href="/v3/repos/contents/#create-a-file"&gt;create&lt;/a&gt;, &lt;a href="/v3/repos/contents/#update-a-file"&gt;update&lt;/a&gt;, and even
567-
&lt;a href="/v3/repos/contents/#delete-a-file"&gt;delete&lt;/a&gt; individual files.&lt;/p&gt;
614+
<link rel="alternate" href="http://developer.github.com/changes/2013-04-30-statuses-for-branches-and-tags/" />
615+
<content type="html">&lt;p&gt;Last week we announced &lt;a href="https://github.com/blog/1484-check-the-status-of-your-branches"&gt;support for build statuses in the branches page&lt;/a&gt;.
616+
Now we are extending this to the API. The &lt;a href="http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref"&gt;API endpoint for commit statuses&lt;/a&gt;
617+
has been extended to allow branch and tag names, as well as commit SHAs.&lt;/p&gt;
568618

569-
&lt;p&gt;Happy editing!&lt;/p&gt;</content>
619+
&lt;pre class="terminal"&gt;
620+
curl https://api.github.com/repos/rails/rails/statuses/3-2-stable
621+
&lt;/pre&gt;
622+
623+
&lt;p&gt;Enjoy.&lt;/p&gt;</content>
570624
</entry>
571625
<entry>
572626
<id>tag:developer.github.com,2013-04-30:/changes/2013-04-30-improved-submodule-support-in-repository-contents-api/</id>
@@ -607,26 +661,6 @@ curl https://api.github.com/repos/jquery/jquery/contents/test/qunit
607661

608662
&lt;p&gt;If you have any questions or feedback, please drop us a line at
609663
&lt;a href="mailto:[email protected]?subject=Submodules%20in%20Repository%20Contents%20API"&gt;[email protected]&lt;/a&gt;.&lt;/p&gt;</content>
610-
</entry>
611-
<entry>
612-
<id>tag:developer.github.com,2013-04-30:/changes/2013-04-30-statuses-for-branches-and-tags/</id>
613-
<title type="html">Commit Statuses Now Available for Branches and Tags</title>
614-
<published>2013-04-30T04:00:00Z</published>
615-
<updated>2013-04-30T04:00:00Z</updated>
616-
<author>
617-
<name>foca</name>
618-
<uri>https://github.com/technoweenie</uri>
619-
</author>
620-
<link rel="alternate" href="http://developer.github.com/changes/2013-04-30-statuses-for-branches-and-tags/" />
621-
<content type="html">&lt;p&gt;Last week we announced &lt;a href="https://github.com/blog/1484-check-the-status-of-your-branches"&gt;support for build statuses in the branches page&lt;/a&gt;.
622-
Now we are extending this to the API. The &lt;a href="http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref"&gt;API endpoint for commit statuses&lt;/a&gt;
623-
has been extended to allow branch and tag names, as well as commit SHAs.&lt;/p&gt;
624-
625-
&lt;pre class="terminal"&gt;
626-
curl https://api.github.com/repos/rails/rails/statuses/3-2-stable
627-
&lt;/pre&gt;
628-
629-
&lt;p&gt;Enjoy.&lt;/p&gt;</content>
630664
</entry>
631665
<entry>
632666
<id>tag:developer.github.com,2013-04-25:/changes/2013-04-25-deprecating-merge-commit-sha/</id>
@@ -1062,39 +1096,4 @@ DerivedData
10621096
.idea/
10631097
&lt;/code&gt;&lt;/pre&gt;</content>
10641098
</entry>
1065-
<entry>
1066-
<id>tag:developer.github.com,2012-11-27:/changes/2012-11-27-forking-to-organizations/</id>
1067-
<title type="html">Forking to Organizations</title>
1068-
<published>2012-11-27T05:00:00Z</published>
1069-
<updated>2012-11-27T05:00:00Z</updated>
1070-
<author>
1071-
<name>technoweenie</name>
1072-
<uri>https://github.com/technoweenie</uri>
1073-
</author>
1074-
<link rel="alternate" href="http://developer.github.com/changes/2012-11-27-forking-to-organizations/" />
1075-
<content type="html">&lt;p&gt;We made a slight change to the way you fork a repository. By default, you
1076-
can fork my repository through an HTTP POST to the repository’s fork resource.&lt;/p&gt;
1077-
1078-
&lt;pre&gt;&lt;code&gt;$ curl -X POST https://api.github.com/repos/technoweenie/faraday/forks
1079-
&lt;/code&gt;&lt;/pre&gt;
1080-
1081-
&lt;p&gt;This repository forks to your personal account. However, there are cases when
1082-
you want to fork to one of your organizations instead. The previous method
1083-
required a &lt;code&gt;?org&lt;/code&gt; query parameter:&lt;/p&gt;
1084-
1085-
&lt;pre&gt;&lt;code&gt;$ curl -X POST /repos/technoweenie/faraday/forks?org=mycompany
1086-
&lt;/code&gt;&lt;/pre&gt;
1087-
1088-
&lt;p&gt;Query parameters on POST requests are unusual in APIs, and definitely
1089-
inconsistent with the rest of the GitHub API. You should be able to post a
1090-
JSON body like every other POST endpoint. Now, you can! Only, now we’re
1091-
calling the field &lt;code&gt;organization&lt;/code&gt;.&lt;/p&gt;
1092-
1093-
&lt;pre&gt;&lt;code&gt;$ curl /repos/technoweenie/faraday/forks?org=mycompany \
1094-
-d '{"organization": "mycompany"}'
1095-
&lt;/code&gt;&lt;/pre&gt;
1096-
1097-
&lt;p&gt;Don’t worry, we are committed to maintaining the legacy behavior until the next
1098-
major change of the GitHub API.&lt;/p&gt;</content>
1099-
</entry>
11001099
</feed>

0 commit comments

Comments
 (0)