From 57b5d28fd43366cc7a08ca6cbf267caa9263a46a Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Wed, 23 May 2012 18:16:37 +1000 Subject: [PATCH] WIP api docs - matrix (not bad) --- APIFolder/api.htm | 89 ++++-------------------------------- APIFolder/apicss/apidocs.css | 56 ++++++++++++++++++----- 2 files changed, 55 insertions(+), 90 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 3a7c55dd8..41c759cea 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -29,7 +29,7 @@
- + @@ -50,10 +50,10 @@

Configuration

-
+
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
- +
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
@@ -61,103 +61,34 @@

Additional Fields

-
+
- - - - - - - - - - - - - - - - + - - - - - - - - - -
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
USER/v1/usersCreate a UserList Users--
/v1/users/{userId}-Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles--
/v1/roles/{roleId}-Retrieve a RoleUpdate a Role-
PERMISSION/v1/permissions-List Application Permissions--

Report

-
+
- - - - - - - - - - - - - - - - - - + - - - - - - - -
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
USER/v1/usersCreate a UserList Users--
/v1/users/{userId}-Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles--
/v1/roles/{roleId}-Retrieve a RoleUpdate a Role-
PERMISSION/v1/permissions-List Application Permissions--

User Related

-
+
- - - - - - - - - - - - - - - - - - - - + @@ -172,7 +103,7 @@

Convenience API

-
+
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
diff --git a/APIFolder/apicss/apidocs.css b/APIFolder/apicss/apidocs.css index 865abf5f2..d908c83d0 100644 --- a/APIFolder/apicss/apidocs.css +++ b/APIFolder/apicss/apidocs.css @@ -1,5 +1,5 @@ .tocMatrix { - font-size: 75%; + font-size: 85%; } .matrixHeading { @@ -82,7 +82,7 @@ body { height: 40px; min-width: 745px; left: 0; right: 0; top: 0; - padding-left: 100px; + padding-left: 200px; background: #eee; background: -webkit-gradient(linear, left top, left bottom, from(#f8f8f8), to(#dadada)); background: -moz-linear-gradient(top, #f8f8f8, #dadada); @@ -170,12 +170,46 @@ body { box-shadow: 0 3px 5px rgba(0,0,0,0.1); } -#toc-menu { - right: -480px; +.flybar-menu-convenience { + display: none; + position: absolute; + top: 41px; + + width: 600px; + background-color: rgba(249, 249, 249, 0.99); + border: 1px solid rgb(187, 187, 187); + border-top: 0; + padding: 1em; + border-bottom-left-radius: 8px; + border-bottom-right-radius: 8px; + -webkit-box-shadow: 0 3px 5px rgba(0,0,0,0.1); + -moz-box-shadow: 0 3px 5px rgba(0,0,0,0.1); + box-shadow: 0 3px 5px rgba(0,0,0,0.1); +} + +#toc-menu1 { + position:absolute; + left:-150px; } #toc-menu2 { - right: -480px; + position:absolute; + left:-300px; +} + +#toc-menu3 { + position:absolute; + left:-450px; +} + +#toc-menu4 { + position:absolute; + left:-600px; +} + +#toc-menu5 { + position:absolute; + left:-450px; } #language-menu { @@ -187,24 +221,24 @@ body { margin-right: 25px; } -.flybar-menu h3, .flybar-menu-overview h3 { +.flybar-menu h3, .flybar-menu-overview h3, .flybar-menu-convenience h3 { text-transform: uppercase; font-size: 100%; } -.flybar-menu h4, , .flybar-menu-overview h4 { +.flybar-menu h4, .flybar-menu-overview h4, .flybar-menu-convenience h4 { text-transform: uppercase; font-size: 90%; color: rgb(155, 155, 155); margin: 0.5em 0 0.5em 0; } -.flybar-menu ul, , .flybar-menu-overview ul { +.flybar-menu ul, .flybar-menu-overview ul, .flybar-menu-convenience ul { margin: 0 0 1em 1em; } -.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview, -.flybar-nav.active .flybar-menu, .flybar-nav.active .flybar-menu-overview { +.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview, .flybar-nav:hover .flybar-menu-convenience, +.flybar-nav.active .flybar-menu, .flybar-nav.active .flybar-menu-overview, .flybar-nav.active .flybar-menu-convenience{ display: block; } @@ -219,7 +253,7 @@ body { border-right: 1px solid rgb(187, 187, 187); } -.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview, +.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview, .flybar-nav:hover .flybar-menu-convenience, .flybar-button.active { margin-right: -1px; }
Convenience Resources
GET
read