From 954db2bf80a4828b6169276cc458d1b7b08772ef Mon Sep 17 00:00:00 2001 From: Guillaume Kergreis Date: Thu, 4 Jun 2020 16:51:17 +0200 Subject: [PATCH] docfix/Correct data import Correct data import instructions in README.md --- README.md | 4 ++-- .../src/main/resources/ResourceDocs/ResourceDocs-Chinese.json | 2 +- obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7ec02a15b..cbeb07454 100644 --- a/README.md +++ b/README.md @@ -221,8 +221,8 @@ To populate the OBP database with sandbox data: 1) In the API's props file, set `allow_sandbox_data_import=true` 2) Grant your user the role `CanCreateSandbox`. See previous section on how to do this -5) Now post the JSON data using the payload field at `/#2_1_0-sandboxDataImport` -6) If successful you should see an empty result `{}` and no error message +3) Now post the JSON data using the payload field at `/#2_1_0-sandboxDataImport`. An example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json) +4) If successful you should see this result `{ "success": "Success" }` and no error message diff --git a/obp-api/src/main/resources/ResourceDocs/ResourceDocs-Chinese.json b/obp-api/src/main/resources/ResourceDocs/ResourceDocs-Chinese.json index 520aaa253..6e173c028 100644 --- a/obp-api/src/main/resources/ResourceDocs/ResourceDocs-Chinese.json +++ b/obp-api/src/main/resources/ResourceDocs/ResourceDocs-Chinese.json @@ -14854,7 +14854,7 @@ "request_url": "/obp/v2.1.0/sandbox/data-import", "summary": "创建沙箱", "description": "映射（类型->字符串）", - "description_markdown": "Import bulk data into the sandbox (Authenticated access).\n\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.\n\nThe user needs to have CanCreateSandbox entitlement.\n\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.\n\nAn example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json)\nAuthentication is Mandatory\n", + "description_markdown": "Import bulk data into the sandbox (Authenticated access).\n\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.\n\nThe user needs to have CanCreateSandbox entitlement.\n\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.\n\nAn example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json)\nAuthentication is Mandatory\n", "example_request_body": { "banks": [ { diff --git a/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala b/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala index c5f7da5d2..6233b000a 100644 --- a/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala +++ b/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala @@ -89,7 +89,7 @@ trait APIMethods210 { | |Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data. | - |An example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json) + |An example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json) |${authenticationRequiredMessage(true)} |""", SandboxData.importJson,