Rename check digit URL, add documentation

Author: jmarin

Documents/public-api.md

@@ -84,6 +84,149 @@ This documenatation describes de public HMDA Platform HTTP API
 For a definition of these fields, please consult the [HMDA Filing Instructions Guide](http://www.consumerfinance.gov/data-research/hmda/static/for-filers/2017/2017-HMDA-FIG.pdf).
 Please note that the Modified LAR does not include the fields `Loan Application Number`, `Date Application Received` or `Date of Action` described in HMDA Filing Instructions Guide.
 
+## Check Digit
 
+### Check digit generation
+
+* `/uli/checkDigit`
+
+   * `POST` - Calculates check digit and full ULI from a loan id.
+
+Example payload, in `JSON` format:
+
+```json
+{
+  "loanId": "10Bx939c5543TqA1144M999143X"
+}
+```
+
+Example response:
+
+```json
+{
+    "loanId": "10Cx939c5543TqA1144M999143X",
+    "checkDigit": 10,
+    "uli": "10Cx939c5543TqA1144M999143X10"
+}
+```
+
+A file with a list of Loan Ids can also be uploaded to this endpoint for batch check digit generation.
+
+Example file contents:
+
+```
+10Cx939c5543TqA1144M999143X
+10Bx939c5543TqA1144M999143X
+```
+
+Example response in `JSON` format:
+
+```json
+{
+    "loanIds": [
+        {
+            "loanId": "10Bx939c5543TqA1144M999143X",
+            "checkDigit": 38,
+            "uli": "10Bx939c5543TqA1144M999143X38"
+        },
+        {
+            "loanId": "10Cx939c5543TqA1144M999143X",
+            "checkDigit": 10,
+            "uli": "10Cx939c5543TqA1144M999143X10"
+        }
+    ]
+}
+```
+
+* `/uli/checkDigit/csv`
+
+   * `POST` - calculates check digits for loan ids submitted as a file
+
+Example file contents:
+
+```
+10Cx939c5543TqA1144M999143X
+10Bx939c5543TqA1144M999143X
+```
+
+Example response in `CSV` format:
+
+```csv
+10Bx939c5543TqA1144M999143X,38,10Bx939c5543TqA1144M999143X38
+10Cx939c5543TqA1144M999143X,10,10Cx939c5543TqA1144M999143X10
+```
+
+### ULI Validation
+
+* `/uli/validate`
+
+   * `POST` - Validates a ULI (correct check digit)
+
+Example payload, in `JSON` format:
+
+```json
+{
+	"uli": "10Bx939c5543TqA1144M999143X38"
+}
+```
+
+Example response:
+
+```json
+{
+    "isValid": true
+}
+```
+
+A file with a list of ULIs can also be uploaded to this endpoint for batch ULI validation.
+
+Example file contents:
+
+```
+10Cx939c5543TqA1144M999143X10
+10Bx939c5543TqA1144M999143X38
+10Bx939c5543TqA1144M999133X38
+```
+
+Example response in `JSON` format:
+
+```json
+{
+    "ulis": [
+        {
+            "uli": "10Cx939c5543TqA1144M999143X10",
+            "isValid": true
+        },
+        {
+            "uli": "10Bx939c5543TqA1144M999143X38",
+            "isValid": true
+        },
+        {
+            "uli": "10Bx939c5543TqA1144M999133X38",
+            "isValid": false
+        }
+    ]
+}
+```
+
+* `/uli/validate/csv`
+
+   * `POST` - Batch validation of ULIs
+
+Example file contents:
+
+```
+10Cx939c5543TqA1144M999143X10
+10Bx939c5543TqA1144M999143X38
+10Bx939c5543TqA1144M999133X38
+```
+
+Example response in `CSV` format:
+
+```csv
+10Cx939c5543TqA1144M999143X10,true
+10Bx939c5543TqA1144M999143X38,true
+10Bx939c5543TqA1144M999133X38,false
+```
 
 

api/src/main/scala/hmda/api/http/public/PublicHttpApi.scala

@@ -35,7 +35,7 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives with ApiE
           modifiedLar(instId)
         } ~
           pathPrefix("uli") {
-            path("check-digit") {
+            path("checkDigit") {
               timedPost { _ =>
                 entity(as[Loan]) { loan =>
                   val loanId = loan.loanId
@@ -59,7 +59,7 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives with ApiE
                   }
               }
             } ~
-              path("check-digit" / "csv") {
+              path("checkDigit" / "csv") {
                 timedPost { _ =>
                   fileUpload("file") {
                     case (_, byteSource) =>

api/src/test/scala/hmda/api/http/public/PublicHttpApiSpec.scala

@@ -56,12 +56,12 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
     val uliCheck = ULICheck(uli)
 
     "return check digit and ULI from loan id" in {
-      Post("/uli/check-digit", loan) ~> publicHttpRoutes ~> check {
+      Post("/uli/checkDigit", loan) ~> publicHttpRoutes ~> check {
         responseAs[ULI] mustBe ULI(loanId, checkDigit, uli)
       }
     }
     "return check digit and ULI from file of loan ids" in {
-      Post("/uli/check-digit", loanFile) ~> publicHttpRoutes ~> check {
+      Post("/uli/checkDigit", loanFile) ~> publicHttpRoutes ~> check {
         status mustBe StatusCodes.OK
         responseAs[LoanCheckDigitResponse].loanIds mustBe Seq(
           ULI("10Bx939c5543TqA1144M999143X", 38, "10Bx939c5543TqA1144M999143X38"),
@@ -70,7 +70,7 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
       }
     }
     "return csv with check digit and ULI from file of loan ids" in {
-      Post("/uli/check-digit/csv", loanFile) ~> publicHttpRoutes ~> check {
+      Post("/uli/checkDigit/csv", loanFile) ~> publicHttpRoutes ~> check {
         status mustBe StatusCodes.OK
         val csv = responseAs[String]
         csv must include("10Bx939c5543TqA1144M999143X,38,10Bx939c5543TqA1144M999143X38")