•  
     
    story #5589 read a meaningful api documentation
Summary
user
read a meaningful api documentation
I do not have those type of sentence in the explorer:
- routes to \Tuleap\Project\REST\v1\ProjectResource::getPlannings();
- Add PHPDoc long description to ProjectResource::getPlannings(); (the api method) to write here
- add @param {type} $id {comment} to describe here
- -- no return defined as restler try to instanciate the corresponding object and it makes api-explorer cry -- (either fix it or move in the description of the resource instead of the parameter)
- if time permits, fix "POST /tokens" documentation
Empty
Empty
Empty
Status
Empty
Done
Development
  • [ ] Does it involves User Interface? 
  • [ ] Are there any mockups?
  • [ ] Are permissions checked?
  • [ ] Does it need Javascript development?
  • [ ] Does it need a forge upgrade bucket?
  • [ ] Does it need to execute things in system events?
  • [ ] Does it impact project creation (templates)?
  • [ ] Is it exploratory?
Empty
Details
#5589
Nicolas Terray (nterray)
2013-12-04 17:56
2013-11-18 15:21
3159

References
Referencing story #5589
Referenced by story #5589

Follow-ups

User avatar
  • I want to
    -Update existing do 
    +read a meaningful api documentation 
  • So that
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • As a
    - 
    +user