From da40f1a29a4425ecbedd83249b4057e3512670ab Mon Sep 17 00:00:00 2001 From: Tristan Patch Date: Mon, 13 Jun 2016 13:57:50 -0700 Subject: [PATCH] Add documentation to allow a ?user parameter on projects. --- source/api.rst | 6 +++++- source/usage/administration.rst | 11 +++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/source/api.rst b/source/api.rst index cf1f8c8..598fe66 100644 --- 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 index 8f6fd15..d9c78e3 100644 --- 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.