Initial commit
This is definitely not functional yet. Signed-off-by: Jacob Kiers <code@kiers.eu>
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Bank2FF
|
||||
|
||||
Bank2FF is a tool that can retrieve bank transactions from Gocardless and
|
||||
add them to Firefly III.
|
||||
|
||||
It contains autogenerated APIs for both Firefly III and for the
|
||||
Gocardless Bank Account Data API.
|
||||
|
||||
## Usage
|
||||
|
||||
TBD
|
||||
|
||||
|
||||
## Generating the API clients
|
||||
|
||||
These API clients are generated with the OpenAPI Generators for Rust.
|
||||
|
||||
These need Podman installed, and assume this command is run from the same
|
||||
directory where this README.md file is located.
|
||||
|
||||
For Gocardless:
|
||||
|
||||
`podman run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -g rust -o /local/gocardless-bankaccount-data-api -i 'https://bankaccountdata.gocardless.com/api/v2/swagger.json' --additional-properties=library=reqwest,packageName=gocardless-bankaccount-data-api,packageVersion=2.0.0,supportMiddleware=true,avoidBoxedModels=true`
|
||||
|
||||
|
||||
For Firefly III:
|
||||
|
||||
If necessary, change the URL to the definition. If that is a new version, then also change the `packageVersion` parameter.
|
||||
|
||||
`podman run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -g rust -o /local/firefly-iii-api -i 'https://api-docs.firefly-iii.org/firefly-iii-2.1.0-v1.yaml' --additional-properties=library=reqwest,packageName=firefly-iii-api,packageVersion=2.1.0,supportMiddleware=true,avoidBoxedModels=true`
|
||||
Reference in New Issue
Block a user