From 0070dfa611e4ea7e91803c63c9cff80bc59d1b87 Mon Sep 17 00:00:00 2001 From: Keith Woodlock Date: Fri, 3 May 2013 14:51:19 +0100 Subject: [PATCH] MIFOSX-322: update api docs. --- api-docs/apiLive.htm | 446 ++++++++---------- .../command/RoleCommand.java | 28 -- ...WritePlatformServiceJpaRepositoryImpl.java | 5 +- .../RoleDataValidator.java} | 12 +- ...WritePlatformServiceJpaRepositoryImpl.java | 5 +- .../UserDataValidator.java} | 13 +- 6 files changed, 221 insertions(+), 288 deletions(-) delete mode 100644 mifosng-provider/src/main/java/org/mifosplatform/useradministration/command/RoleCommand.java rename mifosng-provider/src/main/java/org/mifosplatform/useradministration/{serialization/RoleCommandValidator.java => service/RoleDataValidator.java} (90%) rename mifosng-provider/src/main/java/org/mifosplatform/useradministration/{serialization/UserCommandFromApiJsonDeserializerHelper.java => service/UserDataValidator.java} (92%) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 77e3c1b67..1c8e63e87 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -1346,17 +1346,6 @@ - - clients/template Retrieve Client Template @@ -1373,21 +1362,6 @@ loans/{loanId}/transactions/template Retrieve Loan Transaction Template - - offices/template Retrieve Office Template @@ -1396,18 +1370,18 @@ users/template Retrieve User Template - - audits/searchtemplate - Retrieve Audit Search Template - - - makercheckers/searchtemplate - Retrieve Maker Checker Search Template - - - reports/template - Retrieve Report Template - + + audits/searchtemplate + Retrieve Audit Search Template + + + makercheckers/searchtemplate + Retrieve Maker Checker Search Template + + + reports/template + Retrieve Report Template + @@ -13589,6 +13563,102 @@ GET https://DomainName/api/v1/search?query=000000111 Update a Collateral Delete a Collateral + + General Ledger Account + glaccounts + Create a New Ledger Account + List Ledger Accounts + + + + + + glaccounts/{glaccountId} + + Retrieve a Ledger Account + Update a Ledger Account + Delete a Ledger Account + + + Accounting Closure + glclosures + Create an Accounting Closure + List Accounting Closures + + + + + + glclosures/{glclosureId} + + Retrieve an Accounting Closure + Update an Accounting Closure + Delete an Accounting Closure + + + Journal Entries + journalentries + Create Journal Entries + List Journal Entries + + + + + + journalentries/{entryId} + + Retrieve a single Entry + + + + + + journalentries/{transactionId}/reversal + Reverse Journal Entries + + + + + + Report + reports + Create a Report + List Reports + + + + + + reports/template + + Retrieve Report Template + + + + + + reports/{id} + + Retrieve a Report + Update a Report + Delete a Report + + + Run Report + runreports/{reportName} + + Run a Report + + + + + Search + search + + Search Resources + + + Office offices @@ -13623,104 +13693,6 @@ GET https://DomainName/api/v1/search?query=000000111 Configuration - - Global Configuration - configurations - - Retrieve - Global Configuration - Update Global - Configuration - - - - Codes - codes - Create a Code - List Codes - - - - - - codes/{codeId} - - Retrieve a Code - Update a Code - Delete a Code - - - Code Values - codes/{codeId}/codevalues - Create a Code Value - List Code Values - - - - - - codes/{codeId}/codevalues/{codevalueId} - - Retrieve a Code Value - Update a Code Value - Delete a Code Value - - - Audits - audits - - List Audits - - - - - - audits/searchtemplate - - Retrieve Audit Search Template - - - - - - audits/{auditId} - - Retrieve an Audit Entry - - - - - Makercheckers - makercheckers - - List Maker Checker Entries - - - - - - makercheckers/searchtemplate - - Retrieve Maker Checker Search Template - - - - - - makercheckers/{auditId} - - - - Delete Maker Checker Entry - - - - makercheckers/{auditId}?command=approve - Approve Maker Checker Entry - - - - Funds funds @@ -13842,7 +13814,7 @@ GET https://DomainName/api/v1/search?query=000000111 - + Notes {resource}/{resourceId}/notes Add a Resource Note @@ -13850,7 +13822,7 @@ GET https://DomainName/api/v1/search?query=000000111 - + {resource}/{resourceId}/notes/{noteId} @@ -13860,102 +13832,6 @@ GET https://DomainName/api/v1/search?query=000000111 Delete a Resource Note - Search - search - - Search Resources - - - - - General Ledger Account - glaccounts - Create a New Ledger Account - List Ledger Accounts - - - - - - glaccounts/{glaccountId} - - Retrieve a Ledger Account - Update a Ledger Account - Delete a Ledger Account - - - Accounting Closure - glclosures - Create an Accounting Closure - List Accounting Closures - - - - - - glclosures/{glclosureId} - - Retrieve an Accounting Closure - Update an Accounting Closure - Delete an Accounting Closure - - - Journal Entries - journalentries - Create Journal Entries - List Journal Entries - - - - - - journalentries/{entryId} - - Retrieve a single Entry - - - - - - journalentries/{transactionId}/reversal - Reverse Journal Entries - - - - - - Report - reports - Create a Report - List Reports - - - - - - reports/template - - Retrieve Report Template - - - - - - reports/{id} - - Retrieve a Report - Update a Report - Delete a Report - - - Run Report - runreports/{reportName} - - Run a Report - - - - Authentication authentication Verify Authentication @@ -13963,7 +13839,7 @@ GET https://DomainName/api/v1/search?query=000000111 - + User users Create a User @@ -13971,7 +13847,7 @@ GET https://DomainName/api/v1/search?query=000000111 - + users/template @@ -14020,7 +13896,103 @@ GET https://DomainName/api/v1/search?query=000000111 List Application Permissions Enable/Disable Permissions for Maker Checker - + + + Global Configuration + configurations + + Retrieve Global Configuration + Update Global Configuration + + + + Codes + codes + Create a Code + List Codes + + + + + + codes/{codeId} + + Retrieve a Code + Update a Code + Delete a Code + + + Code Values + codes/{codeId}/codevalues + Create a Code Value + List Code Values + + + + + + codes/{codeId}/codevalues/{codevalueId} + + Retrieve a Code Value + Update a Code Value + Delete a Code Value + + + Audits + audits + + List Audits + + + + + + audits/searchtemplate + + Retrieve Audit Search Template + + + + + + audits/{auditId} + + Retrieve an Audit Entry + + + + + Makercheckers + makercheckers + + List Maker Checker Entries + + + + + + makercheckers/searchtemplate + + Retrieve Maker Checker Search Template + + + + + + makercheckers/{auditId} + + + + Delete Maker Checker Entry + + + + makercheckers/{auditId}?command=approve + Approve Maker Checker Entry + + + + diff --git a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/command/RoleCommand.java b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/command/RoleCommand.java deleted file mode 100644 index e7da8d3e3..000000000 --- a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/command/RoleCommand.java +++ /dev/null @@ -1,28 +0,0 @@ -/** - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this file, - * You can obtain one at http://mozilla.org/MPL/2.0/. - */ -package org.mifosplatform.useradministration.command; - -/** - * Immutable command for creating or updating details of a role. - */ -public class RoleCommand { - - private final String name; - private final String description; - - public RoleCommand(final String name, final String description) { - this.name = name; - this.description = description; - } - - public String getName() { - return name; - } - - public String getDescription() { - return description; - } -} \ No newline at end of file diff --git a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/AppUserWritePlatformServiceJpaRepositoryImpl.java b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/AppUserWritePlatformServiceJpaRepositoryImpl.java index d5eb22fe7..6179ee8c1 100644 --- a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/AppUserWritePlatformServiceJpaRepositoryImpl.java +++ b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/AppUserWritePlatformServiceJpaRepositoryImpl.java @@ -30,7 +30,6 @@ import org.mifosplatform.useradministration.domain.RoleRepository; import org.mifosplatform.useradministration.domain.UserDomainService; import org.mifosplatform.useradministration.exception.RoleNotFoundException; import org.mifosplatform.useradministration.exception.UserNotFoundException; -import org.mifosplatform.useradministration.serialization.UserCommandFromApiJsonDeserializerHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -50,12 +49,12 @@ public class AppUserWritePlatformServiceJpaRepositoryImpl implements AppUserWrit private final AppUserRepository appUserRepository; private final OfficeRepository officeRepository; private final RoleRepository roleRepository; - private final UserCommandFromApiJsonDeserializerHelper fromApiJsonDeserializer; + private final UserDataValidator fromApiJsonDeserializer; @Autowired public AppUserWritePlatformServiceJpaRepositoryImpl(final PlatformSecurityContext context, final AppUserRepository appUserRepository, final UserDomainService userDomainService, final OfficeRepository officeRepository, final RoleRepository roleRepository, - final PlatformPasswordEncoder platformPasswordEncoder, final UserCommandFromApiJsonDeserializerHelper fromApiJsonDeserializer) { + final PlatformPasswordEncoder platformPasswordEncoder, final UserDataValidator fromApiJsonDeserializer) { this.context = context; this.appUserRepository = appUserRepository; this.userDomainService = userDomainService; diff --git a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/serialization/RoleCommandValidator.java b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleDataValidator.java similarity index 90% rename from mifosng-provider/src/main/java/org/mifosplatform/useradministration/serialization/RoleCommandValidator.java rename to mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleDataValidator.java index 64d65a8be..4dadab0ab 100644 --- a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/serialization/RoleCommandValidator.java +++ b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleDataValidator.java @@ -3,7 +3,7 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this file, * You can obtain one at http://mozilla.org/MPL/2.0/. */ -package org.mifosplatform.useradministration.serialization; +package org.mifosplatform.useradministration.service; import java.lang.reflect.Type; import java.util.ArrayList; @@ -26,7 +26,7 @@ import com.google.gson.JsonElement; import com.google.gson.reflect.TypeToken; @Component -public final class RoleCommandValidator { +public final class RoleDataValidator { /** * The parameters supported for this command. @@ -36,7 +36,7 @@ public final class RoleCommandValidator { private final FromJsonHelper fromApiJsonHelper; @Autowired - public RoleCommandValidator(final FromJsonHelper fromApiJsonHelper) { + public RoleDataValidator(final FromJsonHelper fromApiJsonHelper) { this.fromApiJsonHelper = fromApiJsonHelper; } @@ -85,10 +85,6 @@ public final class RoleCommandValidator { } private void throwExceptionIfValidationWarningsExist(final List dataValidationErrors) { - if (!dataValidationErrors.isEmpty()) { - // - throw new PlatformApiDataValidationException("validation.msg.validation.errors.exist", "Validation errors exist.", - dataValidationErrors); - } + if (!dataValidationErrors.isEmpty()) { throw new PlatformApiDataValidationException(dataValidationErrors); } } } \ No newline at end of file diff --git a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleWritePlatformServiceJpaRepositoryImpl.java b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleWritePlatformServiceJpaRepositoryImpl.java index a2ac05bb0..39dc3a3e7 100644 --- a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleWritePlatformServiceJpaRepositoryImpl.java +++ b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/RoleWritePlatformServiceJpaRepositoryImpl.java @@ -22,7 +22,6 @@ import org.mifosplatform.useradministration.domain.RoleRepository; import org.mifosplatform.useradministration.exception.PermissionNotFoundException; import org.mifosplatform.useradministration.exception.RoleNotFoundException; import org.mifosplatform.useradministration.serialization.PermissionsCommandFromApiJsonDeserializer; -import org.mifosplatform.useradministration.serialization.RoleCommandValidator; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -37,12 +36,12 @@ public class RoleWritePlatformServiceJpaRepositoryImpl implements RoleWritePlatf private final PlatformSecurityContext context; private final RoleRepository roleRepository; private final PermissionRepository permissionRepository; - private final RoleCommandValidator roleCommandFromApiJsonDeserializer; + private final RoleDataValidator roleCommandFromApiJsonDeserializer; private final PermissionsCommandFromApiJsonDeserializer permissionsFromApiJsonDeserializer; @Autowired public RoleWritePlatformServiceJpaRepositoryImpl(final PlatformSecurityContext context, final RoleRepository roleRepository, - final PermissionRepository permissionRepository, final RoleCommandValidator roleCommandFromApiJsonDeserializer, + final PermissionRepository permissionRepository, final RoleDataValidator roleCommandFromApiJsonDeserializer, final PermissionsCommandFromApiJsonDeserializer fromApiJsonDeserializer) { this.context = context; this.roleRepository = roleRepository; diff --git a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/serialization/UserCommandFromApiJsonDeserializerHelper.java b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/UserDataValidator.java similarity index 92% rename from mifosng-provider/src/main/java/org/mifosplatform/useradministration/serialization/UserCommandFromApiJsonDeserializerHelper.java rename to mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/UserDataValidator.java index cd2b04b10..3614925af 100644 --- a/mifosng-provider/src/main/java/org/mifosplatform/useradministration/serialization/UserCommandFromApiJsonDeserializerHelper.java +++ b/mifosng-provider/src/main/java/org/mifosplatform/useradministration/service/UserDataValidator.java @@ -3,7 +3,7 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this file, * You can obtain one at http://mozilla.org/MPL/2.0/. */ -package org.mifosplatform.useradministration.serialization; +package org.mifosplatform.useradministration.service; import java.lang.reflect.Type; import java.util.ArrayList; @@ -14,7 +14,6 @@ import java.util.Map; import java.util.Set; import org.apache.commons.lang.StringUtils; -import org.mifosplatform.infrastructure.core.api.JsonCommand; import org.mifosplatform.infrastructure.core.data.ApiParameterError; import org.mifosplatform.infrastructure.core.data.DataValidatorBuilder; import org.mifosplatform.infrastructure.core.exception.InvalidJsonException; @@ -26,11 +25,8 @@ import org.springframework.stereotype.Component; import com.google.gson.JsonElement; import com.google.gson.reflect.TypeToken; -/** - * Implementation for deserializing users {@link JsonCommand} for validation. - */ @Component -public final class UserCommandFromApiJsonDeserializerHelper { +public final class UserDataValidator { /** * The parameters supported for this command. @@ -41,7 +37,7 @@ public final class UserCommandFromApiJsonDeserializerHelper { private final FromJsonHelper fromApiJsonHelper; @Autowired - public UserCommandFromApiJsonDeserializerHelper(final FromJsonHelper fromApiJsonHelper) { + public UserDataValidator(final FromJsonHelper fromApiJsonHelper) { this.fromApiJsonHelper = fromApiJsonHelper; } @@ -78,8 +74,7 @@ public final class UserCommandFromApiJsonDeserializerHelper { } private void throwExceptionIfValidationWarningsExist(final List dataValidationErrors) { - if (!dataValidationErrors.isEmpty()) { throw new PlatformApiDataValidationException("validation.msg.validation.errors.exist", - "Validation errors exist.", dataValidationErrors); } + if (!dataValidationErrors.isEmpty()) { throw new PlatformApiDataValidationException(dataValidationErrors); } } public void validateForUpdate(final String json) {