RFE: Project Version contributor API

We are closing all the old issues to have more clarity in our backlog for Zanata project. Feel free to re-open or leave a comment if you require our attention on your Jira.

Michelle Kim commented:

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

Carlos Munoz commented:

•  

  •  

    • Bug 1227958 has been marked as a duplicate of this bug. ***

David Mason commented:

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"
]
}
]

Carlos Munoz commented:

• Email sharing policy

• Explain roles on the role assignment page

• Contributors API under the project version resource

• Will include dates as a parameter