From 6f2a524193d8bb6de8cd90534170634ea5cab77e Mon Sep 17 00:00:00 2001 From: vladae36 <80091744+vladae36@users.noreply.github.com> Date: Tue, 23 Apr 2024 09:25:24 +0200 Subject: [PATCH] docu --- docs/TEST.md | 2 +- docs/milestones.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/TEST.md b/docs/TEST.md index 040d414..689082d 100644 --- a/docs/TEST.md +++ b/docs/TEST.md @@ -106,7 +106,7 @@ This is not part of the grant but we plan to include if it can be done withing r ## Test API manually with Swagger -Open [Swagger](http://localhost:8093/ebics/swagger-ui/?url=/ebics/v2/api-docs/) in your +Open [Swagger/OpenAPI](http://localhost:8093/ebics/swagger-ui/?url=/ebics/v2/api-docs/) in your browser and test the API and follow instructions [here](manual/manual.md) for a manual test. diff --git a/docs/milestones.md b/docs/milestones.md index cb5b50a..40c1476 100644 --- a/docs/milestones.md +++ b/docs/milestones.md @@ -12,12 +12,12 @@ | 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can start the backend and send test transactions, which will show how the new functionality works.| [Link to Documentation Root](https://github.com/element36-io/ebics-java-service?tab=readme-ov-file) | | 0c. | Testing Guide | Adapt unit tests of core functions and test data to ensure functionality and robustness of the overall system (bridge and proofs). In the guide, we will describe how to run these tests. | See [Testing Guide](TEST.md#clone-repo-and-run-unit-tests).| | 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |[Testing Guide: "Run with Docker"](TEST.md#run-and-test-with-docker), got to "Run and test with Docker". | -| 1. | Generate Receipt | Retrieve data form backend and generate receipt (proof) using the proving system. | [Testing Guide](TEST.md#test-api-and-download-zk-proof), go to Test API and downlaod ZK Proof.| +| 1. | Generate Receipt | Retrieve data form backend and generate receipt (proof) using the proving system. | [Testing Guide](TEST.md#test-api-and-download-zk-proof), go to Test API and download ZK Proof.| | 2. | Provide API | We will provide an application based on Spring-Boot that will contain `getBankstatements():Statement[]` (which includes account balance), `createOrder (OutgoingPayment)` and `simulatePayment(Payment)` as a REST interface as [described](#b-bank-account-rest-api). The recipe data is added in the [backend API](http://w.e36.io:8093/ebics/swagger-ui/?url=/ebics/v2/api-docs/#/) `/ebics/api-v1/bankstatements`` with two new fields in the top level of the JSON-response: `recipeiUrl` so that clients can use a public verifier to check the proof. | [Testing Guide](TEST.md#test-api-manually-with-swagger), go to "Test API manually with Swagger" and follow instructions of screenshots. | | 3. | Provide Banking-UI | Show a UI to see the status of banking backend (show accounts, transactions etc). We will use [LibEuFin](https://github.com/element36-io/ebics-java-service/blob/main/docs/SANDBOX.md) - same as in our first grant. | [Testing Guide](TEST.md#login-to-simulated-banking-backend-ui), go to "Login to simulated banking backend UI" on [localhost:3000](localhost:3000), foo/superpassword | | 4. | Unit Tests | We will adapt unit tests and test data to cover creating and validating proofs. | [Testing Guide](TEST.md), go to "Run unit tests" on top of the document.| | 5. | Repository | Repository will be the existing repo [ebics-java-service](https://github.com/element36-io/ebics-java-service) | [ebics-java-service](https://github.com/element36-io/ebics-java-service) | -| 6. | Backend-Docker | Provide docker-compose images for setting up banking API wrapper, LibEuFin proxy for banking-API. Set up test data in the backend via script and run tests which include the proving system. | [Testing Guide](TEST.md) - when starting services with docker compose. For data and scripts see [here](../scripts/). | +| 6. | Backend-Docker | Provide docker-compose images for setting up banking API wrapper, LibEuFin proxy for banking-API. Set up test data in the backend via script and run tests which include the proving system. | [Testing Guide](TEST.md) - when starting services with docker compose. For data and scripts see [here](../scripts/), especially init_libeufin_sandbox.sh | | 7. | Swagger | Provide Swagger docu for the backend. | [localhost:8093](http://localhost:8093/ebics/swagger-ui/?url=/ebics/v2/api-docs/#/) |