[api] /format endpoint returns JSON-encoded BAI2 file #100
Conversation
api/api.yaml
Outdated
| content: | ||
| application/json: | ||
| schema: | ||
| type: object |
There was a problem hiding this comment.
This return type could be strongly typed, if preferred.
There was a problem hiding this comment.
Yea, can we reuse the OpenAPI models ?
There was a problem hiding this comment.
@adamdecaf sure thing.
I pushed two subsequent commits.
The first fixes the build with respect to lint, etc.
The second adds OpenAPI models for this endpoint. I didn't see any existing models and took a first pass here -- please let me know what changes you'd like to see from here.
There seems to be an active GH outage that is currently these latest commits showing up (2024-03-12 7:45 PM CST) but I'm expecting a new build to trigger eventually.
pkg/service/handlers_test.go
Outdated
|
|
||
| suite.testServer.ServeHTTP(recorder, request) | ||
| assert.Equal(suite.T(), http.StatusOK, recorder.Code) | ||
| assert.Equal(suite.T(), recorder.Body.String(), `{"sender":"0004","receiver":"12345","fileCreatedDate":"060321","fileCreatedTime":"0829","fileIdNumber":"001","physicalRecordLength":80,"blockSize":1,"versionNumber":2,"fileControlTotal":"+00000000001280000","numberOfGroups":1,"numberOfRecords":27,"Groups":[{"receiver":"12345","originator":"0004","groupStatus":1,"asOfDate":"060317","currencyCode":"CAD","groupControlTotal":"+00000000001280000","numberOfAccounts":2,"numberOfRecords":25,"Accounts":[{"accountNumber":"10200123456","currencyCode":"CAD","summaries":[{"TypeCode":"040","Amount":"+000000000000","ItemCount":0,"FundsType":{}},{"TypeCode":"045","Amount":"+000000000000","ItemCount":0,"FundsType":{}},{"TypeCode":"100","Amount":"000000000208500","ItemCount":3,"FundsType":{"type_code":"V","date":"060316"}},{"TypeCode":"400","Amount":"000000000208500","ItemCount":8,"FundsType":{"type_code":"V","date":"060316"}}],"accountControlTotal":"+00000000000834000","numberRecords":14,"Details":[{"TypeCode":"409","Amount":"000000000002500","FundsType":{"type_code":"V","date":"060316"},"BankReferenceNumber":"","CustomerReferenceNumber":"","Text":"RETURNED CHEQUE "}]},{"accountNumber":"10200123456","currencyCode":"CAD","summaries":[{"TypeCode":"040","Amount":"+000000000000","ItemCount":0,"FundsType":{}},{"TypeCode":"045","Amount":"+000000000000","ItemCount":0,"FundsType":{}},{"TypeCode":"100","Amount":"000000000111500","ItemCount":2,"FundsType":{"type_code":"V","date":"060317"}},{"TypeCode":"400","Amount":"000000000111500","ItemCount":4,"FundsType":{"type_code":"V","date":"060317"}}],"accountControlTotal":"+00000000000446000","numberRecords":9,"Details":[{"TypeCode":"108","Amount":"000000000011500","FundsType":{"type_code":"V","date":"060317"},"BankReferenceNumber":"","CustomerReferenceNumber":"","Text":"TFR 1020 0345678 "}]}]}]} |
|
The build failure is fixed in newer OpenAPI versions. If we're going to release a bigger change I'm okay forcing a newer openapi-generator as well. Thoughts? |
|
@adamdecaf I am fine making that upgrade here if you are. |
|
@adamdecaf I updated OpenAPI to The generator generated a new test file named Keeping and running the test would be fine, but it includes a templated Git URL that requires additional configuration / was leading to test failure locally. |
|
Sounds good. Thanks! |
This change proposes a new endpoint for the BAI2 server that validates a BAI2 file and returns a JSON structure of the file. The returned JSON matches the structure that this library uses internally to represent a BAI2 file.