Closed Bug 1011230 Opened 6 years ago Closed 5 years ago

Write an API and vouch FAQ

Categories

(Participation Infrastructure :: Phonebook, defect)

defect
Not set

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: hoosteeno, Assigned: williamr)

References

(Blocks 2 open bugs)

Details

(Whiteboard: [vouching rel. 1])

We need to write an FAQ that will clearly explain the details behind Mozillians.org's authorization and data exposure mechanisms. This bug will capture questions for the FAQ and its resolution will be to create a FAQ page on Mozillians.org.

Initial list of questions (more in comments and blocking bugs):

* How do I get an API key?
* What API applications ("reviewed" applications) have access to the non-public data I put into Mozillians.org? 
* What responsibilities does an API application developer have?
* What should I do if I discover an application misusing the Mozillians.org API or its data?
* How can I get a "reviewed" API key?
Whiteboard: [vouching rel. 2]
I started an etherpad for the FAQ here. It also includes a draft at a review process:

https://mozillians.etherpad.mozilla.org/API-vouch-FAQ-2014-05-19

We could use more questions and more answers, so please contribute.

I suggest that later, more complete versions of this can live on wikimo until/unless we stand up a page in Mozillians.org itself.
William maybe you can take this on?
Flags: needinfo?(williamr)
Assignee: nobody → williamr
Whiteboard: [vouching rel. 2] → [vouching rel. 1]
The vouching FAQ from the etherpad in comment 2 is now at:
https://wiki.mozilla.org/Mozillians/Vouching

The API wiki page has been updated to include an FAQ and the "reviewed" API process:
https://wiki.mozilla.org/Mozillians/API

Please help to make these pages better by editing them.

Giorgos, is there any additional information that should be gathered for a "reviewed" API request? Here are the fields I suggested: 
https://wiki.mozilla.org/Mozillians/API#Process_for_.22Reviewed.22_API_keys

Once those fields are finalized, I'll request a Bugzilla form to be created.
Flags: needinfo?(williamr) → needinfo?(giorgos)
(In reply to William Reynolds [:williamr] from comment #4)
> Giorgos, is there any additional information that should be gathered for a
> "reviewed" API request? Here are the fields I suggested: 
> https://wiki.mozilla.org/Mozillians/API#Process_for_.22Reviewed.22_API_keys
> 
> Once those fields are finalized, I'll request a Bugzilla form to be created.

I think these are enough for now. We may want to revisit with API v2
Flags: needinfo?(giorgos)
William is this ready for release on Thu 24th?
Flags: needinfo?(williamr)
(In reply to Giorgos Logiotatidis [:giorgos] from comment #6)
> William is this ready for release on Thu 24th?

Yes, all ready.
Flags: needinfo?(williamr)
Marking this resolved. The API and vouching FAQ pages from comment 4 have been live for some time. We'll continue to edit those.
Status: NEW → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.