api docs WIP

2012-05-22 17:02:09 +10:00
parent e567a1971b
commit 8a8922b95b
1 changed files with 48 additions and 47 deletions
@@ -179,53 +179,54 @@
                <h4>API Endpoint</h4>
                <code>https://thedomainname/</code>
                <h6>Summary of Resource URL Patterns</h6>
-                <ul>
-                <li>/api/v1/clients</li>
-                <li>/api/v1/clients/template</li>
-                <li>/api/v1/clients/{clientId}</li>
-                <li>/api/v1/clients/{clientId}/loans</li>
-                <li>/api/v1/clients/{clientId}/notes</li>
-                <li>/api/v1/clients/{clientId}/notes/{noteId}</li>
-                
-                <li>/api/v1/loans</li>
-                <li>/api/v1/loans/template</li>
-                <li>/api/v1/loans/{loanId}</li>
-                <li>/api/v1/loans/{loanId}/undo</li>
-                <li>/api/v1/loans/{loanId}/transactions/template</li>
-                <li>/api/v1/loans/{loanId}/transactions</li>
-                <li>/api/v1/loans/{loanId}/transactions/{repaymentId}</li>
-                
-                <li>/api/v1/offices</li>
-                <li>/api/v1/offices/template</li>
-                <li>/api/v1/offices/{officeId}</li>
-                
-                <li>/api/v1/loanproducts</li>
-                <li>/api/v1/loanproducts/template</li>
-                <li>/api/v1/loanproducts/{productId}</li>
-                
-                <li>/api/v1/configurations/currency</li>
-                
-                <li>/api/v1/additionalfields</li>
-                <li>/api/v1/additionalfields/{Type}/{Set}/{id}</li>
-                
-                <li>/api/v1/reports/{reportName}</li>
-                
-                <li>/api/v1/authentication</li>
-                
-                <li>/api/v1/useraccounts/current</li>
-                <li>/api/v1/useraccounts/current/password</li>
-                <li>/api/v1/useraccounts/current/password/template</li>
-                
-                <li>/api/v1/users</li>
-                <li>/api/v1/users/template</li>
-                <li>/api/v1/users/{userId}</li>
-                
-                <li>/api/v1/roles</li>
-                <li>/api/v1/roles/template</li>
-                <li>/api/v1/roles/{roleId}</li>
-                
-                <li>/api/v1/permissions</li>
-                </ul>
+                <table>
+                    <tr><td><b>Resources</b></td><td><b>Verbs</b></td></tr>
+                    <tr><td>/api/v1/clients</td><td>GET</td></tr>
+                    <tr><td>/api/v1/clients/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/clients/{clientId}</td><td>GET</td></tr>
+                    <tr><td>/api/v1/clients/{clientId}/loans</td><td>GET</td></tr>
+                    <tr><td>/api/v1/clients/{clientId}/notes</td><td>GET</td></tr>
+                    <tr><td>/api/v1/clients/{clientId}/notes/{noteId}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/loans</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loans/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loans/{loanId}</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loans/{loanId}/undo</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loans/{loanId}/transactions/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loans/{loanId}/transactions</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loans/{loanId}/transactions/{repaymentId}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/offices</td><td>GET</td></tr>
+                    <tr><td>/api/v1/offices/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/offices/{officeId}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/loanproducts</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loanproducts/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/loanproducts/{productId}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/configurations/currency</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/additionalfields</td><td>GET</td></tr>
+                    <tr><td>/api/v1/additionalfields/{Type}/{Set}/{id}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/reports/{reportName}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/authentication</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/useraccounts/current</td><td>GET</td></tr>
+                    <tr><td>/api/v1/useraccounts/current/password</td><td>GET</td></tr>
+                    <tr><td>/api/v1/useraccounts/current/password/template</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/users</td><td>GET</td></tr>
+                    <tr><td>/api/v1/users/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/users/{userId}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/roles</td><td>GET</td></tr>
+                    <tr><td>/api/v1/roles/template</td><td>GET</td></tr>
+                    <tr><td>/api/v1/roles/{roleId}</td><td>GET</td></tr>
+                    
+                    <tr><td>/api/v1/permissions</td><td>GET</td></tr>
+                </table>
            </div>
        </div>