Bug 1190027 - RFE: Project Version contributor API
Summary: RFE: Project Version contributor API
Keywords:
Status: CLOSED UPSTREAM
Alias: None
Product: Zanata
Classification: Retired
Component: Component-API
Version: development
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: ---
Assignee: Carlos Munoz
QA Contact: Zanata-QA Mailling List
URL:
Whiteboard:
: 1227958 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-02-06 06:05 UTC by Carlos Munoz
Modified: 2015-07-29 03:30 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: 3
Clone Of:
Environment:
Last Closed: 2015-07-29 03:30:17 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1186595 0 unspecified CLOSED rwquest for new API - list users associated with particular project 2021-02-22 00:41:40 UTC

Internal Links: 1186595

Description Carlos Munoz 2015-02-06 06:05:17 UTC
Create a REST API endpoint to query users by several parameters.

Comment 1 Daisy Guo 2015-02-06 06:51:24 UTC
Query by:

-project;
-translation team;
-contribution date period, for example, contributors since 2014-01-01 to 2014-12-31;
-role, for example, reviewers, translators, maintainers. If this parameter is used together with project/translation team, it would be very useful.
-...


Ordered by:
-user id;
-top contributors (is it possible?)

Comment 2 Alex Eng 2015-02-08 22:31:42 UTC
We've got a more detailed statistic API, 
Query by: project version slug + username + date range.

https://zanata.ci.cloudbees.com/job/zanata-api-site/site/zanata-common-api/rest-api-docs/resource_StatisticsResource.html

Comment 3 Carlos Munoz 2015-02-12 01:47:15 UTC
- Email sharing policy
- Explain roles on the role assignment page
- Contributors API under the project version resource
- Will include dates as a parameter

Comment 4 David Mason 2015-02-12 02:35:40 UTC
From developer discussion:

 - This is about translation statistics.
 - The system they want to put the stats in uses email addresses as identifiers (stackalytics.com).
   - Much discussion about sharing of email addresses.
   - We need some sort of email sharing policy that users can see.
   - Options:
     - admin can set policy about whether to share email addresses through the API
     - individual users agree or disagree to share their email address
     - just let a privileged role have access to email addresses
       - Irresponsible people could assign such a role without understanding the implications.
       - Role assignment should have an intermediate step that ensures the admin understands the implications of the role (when it is a role with special implications).
 - Normal searches would not be restricted other than usual API prerequisite, and whether email address is present in the user object data of the payload.
 - Query by project slug + version slug + username + date range
 - Opportunity to clean up account resource service
   - so it can be opened up to users with appropriate permission
   - do not expose password hashes


Estimated initial implementation:

 - add a "project contributor" api
 - usernames filtered by date and project-version.
 - return array of user objects, each with array of locales
   - resource just gives usernames (not email addresses at this point)
 - limit queries to the most recent 1 year of data

Payload would be something like this:
[
  {
    "username": "damason",
    "locales": [
      "en"
    ]
  },
  {
    "username": "camunoz",
    "locales": [
      "es",
      "pt"
    ]
  }
]

Comment 5 Carlos Munoz 2015-06-04 00:58:21 UTC
*** Bug 1227958 has been marked as a duplicate of this bug. ***

Comment 6 Michelle Kim 2015-06-04 01:10:43 UTC
Hi Carlos,

I am putting this RFE higher priority since it is quite a useful information that most of the project maintainer or community would be interested in finding out. 

Can you please check if the current estimate and implementation details are up-to-date?

Thanks
Michelle

Comment 7 Zanata Migrator 2015-07-29 03:30:17 UTC
Migrated; check JIRA for bug status: http://zanata.atlassian.net/browse/ZNTA-299


Note You need to log in before you can comment on or make changes to this bug.