Skip to content
This repository has been archived by the owner on Jan 7, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simonhauck authored Nov 7, 2021
1 parent a806e47 commit d38b9a9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@ This project provides a generated java api for
the [Nordigen](https://nordigen.com/en/account_information_documenation/api-documention/overview/) Banking Api which is
specified [here](https://ob.nordigen.com/api/swagger.json).

Important note:
The api documetnation is is sligtly modified. Some endpoints did not contain a reponse object, which led to Void return types. To prevent this, the response of those endpoints is modified to return a string instead which must be interpreted manually. Also there are some problems with enum generation, which are also modified.
## Modification
The api.yaml is modified to resolve some short comings.
- Path and UUID objects were replace to strings. Some default values were invalid which lead to exceptions
- Some methods returned void. In these cases now the raw string response is returned
- Enums don't include a description. This lead to parsing errors with enums


## Usage
1. This project is provided via `https://jitpack.io`. Add the registry to your `build.gradle`, `pom` or `build.gradle.kts`
Expand Down

0 comments on commit d38b9a9

Please sign in to comment.