Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Convert all variables in examples to upper case

  • Loading branch information...
commit ca2f6fceae59cfb70df59b07d416b9f475d0260f 1 parent 8954552
Erik Michaels-Ober sferik authored

Showing 1 changed file with 13 additions and 11 deletions. Show diff stats Hide diff stats

  1. +13 11 rubygems-org-api.md
24 rubygems-org-api.md
Source Rendered
@@ -38,7 +38,7 @@ examples in the README. You can install the library with the command:
38 38 Gem Methods
39 39 -----------
40 40
41   -### GET - `/api/v1/gems/[name].(json|xml)`
  41 +### GET - `/api/v1/gems/[GEM NAME].(json|xml)`
42 42
43 43 Returns some basic information about the given gem. For example, here's Rails in JSON:
44 44
@@ -109,7 +109,8 @@ or XML:
109 109
110 110 ### GET - `/api/v1/search.(json|xml)?query=[YOUR QUERY]`
111 111
112   -Submit a search to Gemcutter for active gems, just like a search query on the site. Returns an array of the XML or JSON representation of gems that match.
  112 +Submit a search to Gemcutter for active gems, just like a search query on the
  113 +site. Returns an array of the XML or JSON representation of gems that match.
113 114
114 115 $ curl 'http://rubygems.org/api/v1/search.json?query=cucumber'
115 116
@@ -117,7 +118,8 @@ Submit a search to Gemcutter for active gems, just like a search query on the si
117 118
118 119 ### GET - `/api/v1/gems.(json|xml)`
119 120
120   -List all gems that you own. Returns an array of the XML or JSON representation of gems you own.
  121 +List all gems that you own. Returns an array of the XML or JSON representation
  122 +of gems you own.
121 123
122 124 $ curl -H 'Authorization:701243f217cdf23b1370c7b66b65ca97' \
123 125 http://rubygems.org/api/v1/gems.json
@@ -125,7 +127,7 @@ List all gems that you own. Returns an array of the XML or JSON representation o
125 127
126 128 ### POST - `/api/v1/gems`
127 129
128   -Submit a gem to RubyGems.org. Must have your API key supplied and give a built RubyGem in the body of the request.
  130 +Submit a gem to RubyGems.org. Must post a built RubyGem in the request body.
129 131
130 132 $ curl --data-binary @gemcutter-0.2.1.gem \
131 133 -H 'Authorization:701243f217cdf23b1370c7b66b65ca97' \
@@ -160,7 +162,7 @@ Update a previously yanked gem back into RubyGems.org's index. Platform is optio
160 162 Gem Version Methods
161 163 -------------------
162 164
163   -### GET - `/api/v1/versions/[rubygem name].json`
  165 +### GET - `/api/v1/versions/[GEM NAME].json`
164 166
165 167 Returns a JSON array of gem version details like the below:
166 168
@@ -184,7 +186,7 @@ Returns a JSON array of gem version details like the below:
184 186 Gem Version Download Methods
185 187 ----------------------------
186 188
187   -### GET - `/api/v1/versions/[rubygem name]-[rubygem version]/downloads.json`
  189 +### GET - `/api/v1/versions/[GEM NAME]-[GEM VERSION]/downloads.json`
188 190
189 191 Returns a JSON object containing the number of downloads by day for a particular gem version for 90 days of data.
190 192
@@ -197,7 +199,7 @@ Returns a JSON object containing the number of downloads by day for a particular
197 199 ...
198 200 }
199 201
200   -### GET - `/api/v1/versions/[rubygem name]-[rubygem version]/downloads/search.json?from=[start date str]&to=[end date str]`
  202 +### GET - `/api/v1/versions/[GEM NAME]-[GEM VERSION]/downloads/search.json?from=[START DATE]&to=[END DATE]`
201 203
202 204 Returns a JSON object containing the number of downloads by day for a particular gem version for 90 days of data.
203 205
@@ -215,7 +217,7 @@ Returns a JSON object containing the number of downloads by day for a particular
215 217 Owner Methods
216 218 -------------
217 219
218   -### GET - `/api/v1/gems/[rubygem name]/owners.(json|yaml)`
  220 +### GET - `/api/v1/gems/[GEM NAME]/owners.(json|yaml)`
219 221
220 222 View all owners of a gem that you own. These users can all push to this gem.
221 223
@@ -231,7 +233,7 @@ View all owners of a gem that you own. These users can all push to this gem.
231 233 }
232 234 ]
233 235
234   -### POST - `/api/v1/gems/[rubygem name]/owners`
  236 +### POST - `/api/v1/gems/[GEM NAME]/owners`
235 237
236 238 Add an owner to a RubyGem you own, giving that user permission to manage it.
237 239
@@ -241,7 +243,7 @@ Add an owner to a RubyGem you own, giving that user permission to manage it.
241 243
242 244 Owner added successfully.
243 245
244   -### DELETE - `/api/v1/gems/[rubygem name]/owners`
  246 +### DELETE - `/api/v1/gems/[GEM NAME]/owners`
245 247
246 248 Remove a user's permission to manage a RubyGem you own.
247 249
@@ -347,7 +349,7 @@ Retrieve your API key using HTTP basic auth.
347 349
348 350 701243f217cdf23b1370c7b66b65ca97
349 351
350   -### GET - `/api/v1/dependencies?gems=[comma delimited rubygems]`
  352 +### GET - `/api/v1/dependencies?gems=[COMMA DELIMITED GEM NAMES]`
351 353
352 354 Returns a marshalled array of hashes for all versions of given gems. Each hash
353 355 contains a gem version with its dependencies making this useful for resolving dependencies.

0 comments on commit ca2f6fc

Please sign in to comment.
Something went wrong with that request. Please try again.