You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-6Lines changed: 43 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,17 +23,21 @@ The project is built on Python with FastAPI framework. All the regular nuances f
23
23
- Connecting this to cloud will need the following in the `.env` file
24
24
25
25
```bash
26
-
UPLOAD_TOPIC=xxxx
27
-
UPLOAD_SUBSCRIPTION=xxxx
28
-
VALIDATION_TOPIC=xxxx
29
26
QUEUECONNECTION=xxxx
30
27
STORAGECONNECTION=xxxx
28
+
VALIDATION_REQ_TOPIC=xxxx
29
+
VALIDATION_REQ_SUB=xxxx
30
+
VALIDATION_RES_TOPIC=xxxx
31
+
CONTAINER_NAME=xxxx
32
+
AUTH_PERMISSION_URL=xxx
33
+
31
34
```
32
35
33
36
The application connect with the `STORAGECONNECTION` string provided in `.env` file and validates downloaded zipfile using `python-osw-validation` package.
34
37
`QUEUECONNECTION` is used to send out the messages and listen to messages.
35
38
36
-
### How to Setup and Build
39
+
40
+
### How to Set up and Build
37
41
Follow the steps to install the python packages required for both building and running the application
38
42
39
43
1. Setup virtual environment
@@ -56,9 +60,42 @@ Follow the steps to install the python packages required for both building and r
56
60
```
57
61
3. By default `get` call on `localhost:8000/health` gives a sample response
58
62
4. Other routes include a `ping` with get and post. Make `get` or `post` request to `http://localhost:8000/health/ping`
59
-
5. Once the server starts, it will start to listening the subscriber(`UPLOAD_SUBSCRIPTION` should be in env file)
63
+
5. Once the server starts, it will start to listening the subscriber(`VALIDATION_REQ_SUB` should be in env file)
64
+
65
+
66
+
#### Request Format
67
+
68
+
```json
69
+
{
70
+
"messageId": "tdei_record_id",
71
+
"messageType": "workflow_identifier",
72
+
"data": {
73
+
"file_upload_path": "file_upload_path",
74
+
"user_id": "user_id",
75
+
"tdei_project_group_id": "tdei_project_group_id"
76
+
}
77
+
}
78
+
```
79
+
80
+
#### Response Format
81
+
82
+
```json
83
+
{
84
+
"messageId": "tdei_record_id",
85
+
"messageType": "workflow_identifier",
86
+
"data": {
87
+
"file_upload_path": "file_upload_path",
88
+
"user_id": "user_id",
89
+
"tdei_project_group_id": "tdei_project_group_id",
90
+
"success": true/false,
91
+
"message": "message"// if false the error string else empty string
92
+
},
93
+
"publishedDate": "published date"
94
+
}
95
+
```
96
+
60
97
61
-
### How to Setup and run the Tests
98
+
### How to Set up and run the Tests
62
99
63
100
Make sure you have set up the project properly before running the tests, see above for `How to Setup and Build`.
0 commit comments