zfcampus/apigility-documentation — pull request #8 by weierophinney (2014-04-03 21:51:35+00:00)
Title: [WIP] Initial "getting started" documentation

- Cover the welcome screen, initial "settings" screen, "APIs" screen, "Create
New API" dialog, "API
Overview" screen, "RPC Services" screen, "New RPC Service" dialog, various
views and edit screens
in an RPC service, and initial testing of a service.

TODO
----

- [ ] Create a REST service
- [ ] Cover REST terminology
- [ ] Entity
- [ ] Collection
- [ ] Resource
- [ ] Link relations (pass them to the halprimer for details)
- [ ] Fields
- [ ] Required
- [ ] Filters
- [ ] Validators
- [ ] Documentation
- [ ] Collection vs Entity
- [ ] Multiple methods
- [ ] Collection response
- [ ] Entity response
- [ ] POST/PATCH request
- [ ] Authorization
- [ ] Show creating rules
- [ ] Show adding Basic auth
- [ ] Sample controller
- **Need to find some way of demonstrating without needing a database!**
- [ ] Test the service
- [ ] POST without credentials
- [ ] POST with credentials
- [ ] POST with invalid data
- [ ] GET with and without credentials
- [ ] PATCH with credentials
- [ ] Discuss DB-Connected
- [ ] Setup DB Adapter
- [ ] Create DB-Connected
- [ ] Discuss what developer needs to do next
- [ ] Create fields
- [ ] Create documentation
- [ ] Documentation
- [ ] Show link from landing page
- [ ] Show link in navbar
- [ ] Show documentation landing page
- [ ] Show API landing page
- [ ] Show expanded service
- [ ] Show expanded operation