Merge pull request #68 from osuosl/tristan/project-user-parameter

Add documentation to allow a ?user parameter on projects.
osuosl · Jun 13, 2016 · 443dd59 · 443dd59
2 parents 32d0a74 + da40f1a
commit 443dd59
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/source/api.rst b/source/api.rst
@@ -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
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/source/usage/administration.rst b/source/usage/administration.rst
@@ -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.