Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add activity api documentation #24

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions rubygems-org-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Details on interacting with RubyGems.org over HTTP.
* [Gem Download Methods](#gemdownloads): Query for download statistics
* [Owner Methods](#owner): Manage owners for gems
* [Webhook Methods](#webhook): Manage notifications for when gems are pushed
* [Activity Methods](#activity): Query for information about site-wide activity
* [Misc Methods](#misc): Various other interactions with the site

<a id="authorization"> </a>
Expand Down Expand Up @@ -216,18 +217,6 @@ Update a previously yanked gem back into RubyGems.org's index. Platform is optio

Successfully unyanked gem: bills (0.0.1)

### GET - `/api/v1/gems/latest`

Pulls the 50 gems most recently added to RubyGems.org (for the first time). Returns an array of the XML or JSON representation of the gems.

$ curl 'https://rubygems.org/api/v1/gems/latest.json'

### GET - `/api/v1/gems/just_updated`

Pulls the 50 most recently updated gems. Returns an array of the XML or JSON representation of the gems.

$ curl 'https://rubygems.org/api/v1/gems/just_updated.json'

<a id="gemversion"> </a>
Gem Version Methods
-------------------
Expand Down Expand Up @@ -484,6 +473,22 @@ SHA2-hashed concatenation of the gem name, the gem version and your API key.

Successfully deployed webhook for all gems to http://example.com

<a id="activity"> </a>
Activity Methods
------------

### GET - `/api/v1/activity/latest`

Pulls the 50 gems most recently added to RubyGems.org (for the first time). Returns an array of the XML or JSON representation of the gems.

$ curl 'https://rubygems.org/api/v1/activity/latest.json'

### GET - `/api/v1/activity/just_updated`

Pulls the 50 most recently updated gems. Returns an array of the XML or JSON representation of the gem versions.

$ curl 'https://rubygems.org/api/v1/activity/just_updated.json'

<a id="misc"> </a>
Misc Methods
------------
Expand Down