915606 - [API] Document Groups, Languages, Skills, Cities and Countries endpoints

Status: VERIFIED FIXED

(Participation Infrastructure :: Phonebook, defect)

Comment 1

[Justin Crawford [:hoosteeno] [:jcrawford]]

This would be a good opportunity to clean up and enhance the existing API docs, plus move it all to readthedocs.

I may have a chance to pick this bug up soon, unless someone else does first.

Comment 2

[Justin Crawford [:hoosteeno] [:jcrawford]]

PR here: https://github.com/mozilla/mozillians/pull/623/

Comment 3

[Justin Crawford [:hoosteeno] [:jcrawford]]

:williamr, could you review the "Use" section of these new docs? I added some guidelines that I think make sense. If they look at all reasonable, I suggest we push them and refine them in a later push. The absence of such guidelines is an omission that needs fixing soon. 

https://github.com/mozilla/mozillians/pull/623/files#L6R17

Comment 4

[William Reynolds [:williamr]]

(In reply to Justin Crawford [:hoosteeno] from comment #3)
> :williamr, could you review the "Use" section of these new docs? I added
> some guidelines that I think make sense. If they look at all reasonable, I
> suggest we push them and refine them in a later push. The absence of such
> guidelines is an omission that needs fixing soon. 
> 
> https://github.com/mozilla/mozillians/pull/623/files#L6R17

r+. This looks great - thanks Justin!

Comment 5

[[github robot]]

Commit pushed to master at https://github.com/mozilla/mozillians

https://github.com/mozilla/mozillians/commit/86b5dcf83888abfd85a3e458413dbbad810bbb7a
[fix bug 915606] Revise API docs and move to RTD

Comment 6

[William Reynolds [:williamr]]

Verified - the docs are there and look nice.

I have also updated the wiki page for the API to point to the documentation on Read The Docs: https://wiki.mozilla.org/Mozillians/API-Specification#API_Methods