add api docs for top downloads for today

rubygems · Aug 5, 2011 · 0cc6619 · 0cc6619
1 parent 264182e
commit 0cc6619
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/rubygems-org-api.md b/rubygems-org-api.md
@@ -196,6 +196,26 @@ Returns an object containing the total number of downloads on RubyGems.
       "total": 242674788
     }
 
+### GET - `/api/v1/downloads/top.(json|xml|yaml)`
+
+Returns an object containing the top 50 downloaded gem versions for today.
+
+    $ curl https://rubygems.org/api/v1/downloads/top.json
+
+    {
+      "gems": [
+        [
+          # version attributes
+          {
+            'full_name' => 'mime-types-1.16' # more attributes ...
+          },
+          # downloads today
+          2806
+        ],
+        # more download/version pairs ...
+      ]
+    }
+
 ### GET - `/api/v1/downloads/[GEM NAME]-[GEM VERSION].(json|xml|yaml)`
 
 Returns an object containing the total number of downloads for a paritcular gem