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.

Sign up for GitHub

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

Jump to bottom

Add documentation to allow a ?user parameter on projects. #68

Merged
merged 1 commit into from
Jun 13, 2016
Merged

Add documentation to allow a ?user parameter on projects. #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,8 @@ Reference Table
=================== ======================= =======================
Parameter Value(s) Endpoint(s)
=================== ======================= =======================
?user= :username /times
?user= :username - /times
- /projects
?project= :project-slug /times
?activity= :activity-slug /times
?start= :date (ISO format) /times
Expand Down Expand Up @@ -346,6 +347,9 @@ Parameter Value(s) Endpoint(s)
``/times?user=:username``
Filters results to a set of time submitted entries by a specified user.

``/projects?user=:username``
Filters results to a set of projects on which a specified user is a member.

?project=:projectslug
~~~~~~~~~~~~~~~~~~~~~

Expand Down
11 changes: 11 additions & 0 deletions source/usage/administration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,14 @@ Example
An administrator can opt to view only entries by ``alice`` and ``bob`` on the
``awesome-proj`` and ``boring-proj`` from ``2015-02-27`` to ``2015-03-14`` by
setting the parameters on their client to the above values.

----------------------------

Getting a subset of projects
----------------------------

Users
~~~~~

You may also filter projects to only show those on which a given user is a
member, using a query parameter similar to that used with times.