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

adds count endpoints to documentation - partial fix for #125 #164

Merged
merged 1 commit into from
Mar 3, 2016
Merged
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,18 @@ Ask [@acabunoc](http://github.com/acabunoc) for ones marked `###########`. Our c
* GET /users/:orcid/badges
* Get all badge instances earned by a user
* e.g. [/users/0000-0001-5979-8713/badges](http://badges.mozillascience.org/users/0000-0001-5979-8713/badges)
* GET /users/:orcid/badges/count
* Get a count of all badge instances earned by a user
* e.g. [/users/0000-0001-5979-8713/badges/count](http://badges.mozillascience.org/users/0000-0001-5979-8713/badges/count)
* GET /users/:orcid/badges/:badge
* Get all badge instances of a certain badge earned by a user
* e.g. [/users/0000-0001-5979-8713/badges/data_curation](http://badges.mozillascience.org/users/0000-0001-5979-8713/badges/data_curation)
* GET /papers/:doi1/:doi2/badges
* Get all badge instances for a paper.
* e.g. [/papers/10.1186/2047-217X-3-18/badges](http://badges.mozillascience.org/papers/10.1186/2047-217X-3-18/badges)
* GET /papers/:doi1/:doi2/badges/count
* Get a count of all badge instances for a paper.
* e.g. [/papers/10.1186/2047-217X-3-18/badges/count](http://badges.mozillascience.org/papers/10.1186/2047-217X-3-18/badges/count)
* GET /papers/:doi1/:doi2/badges/:badge
* Get all badge instances of a certain badge for a paper.
* e.g. [/papers/10.1186/2047-217X-3-18/badges/investigation](http://badges.mozillascience.org/papers/10.1186/2047-217X-3-18/badges/investigation)
Expand Down
12 changes: 12 additions & 0 deletions templates/pages/home.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ var Home = React.createClass({
<li>e.g. <a href="/users/0000-0001-5979-8713/badges?pretty=true">/users/0000-0001-5979-8713/badges</a></li>
</ul>
</li>
<li>GET /users/:orcid/badges/count
<ul>
<li>Get a count of all badge instances earned by a user</li>
<li>e.g. <a href="/users/0000-0001-5979-8713/badges/count">/users/0000-0001-5979-8713/badges/count</a></li>
</ul>
</li>
<li>GET /users/:orcid/badges/:badge
<ul>
<li>Get all badge instances of a certain badge earned by a user</li>
Expand All @@ -52,6 +58,12 @@ var Home = React.createClass({
<li>e.g. <a href="/papers/10.1186/2047-217X-3-18/badges?pretty=true">/papers/10.1186/2047-217X-3-18/badges</a></li>
</ul>
</li>
<li>GET /papers/:doi1/:doi2/badges/count
<ul>
<li>Get a count of all badge instances for a paper.</li>
<li>e.g. <a href="/papers/10.1186/2047-217X-3-18/badges/count">/papers/10.1186/2047-217X-3-18/badges/count</a></li>
</ul>
</li>
<li>GET /papers/:doi1/:doi2/badges/:badge
<ul>
<li>Get all badge instances of a certain badge for a paper.</li>
Expand Down