@@ -123,55 +123,34 @@ This project presents a Flask-based API for validating RO-Crates.
123123
124124##### Parameters
125125
126- > | name | type | data type | description |
127- > |------------|-----------|-------------------------|-----------------------------------------------------------------------|
128- > | crate_json | required | string | RO-Crate metadata, stored as a single string |
129- > | profile_name | optional | string | RO-Crate profile to validate against |
126+ | name | type | data type | description |
127+ |------------|-----------|-------------------------|-----------------------------------------------------------------------|
128+ | crate_json | required | string | RO-Crate metadata, stored as a single string |
129+ | profile_name | optional | string | RO-Crate profile to validate against |
130130
131131
132132##### Responses
133133
134- > | http code | content-type | response |
135- > |---------------|-----------------------------------|---------------------------------------------------------------------|
136- > | ` 200 ` | ` application/ json` | ` Successful Validation` |
137- > | ` 422 ` | ` application/ json` | ` Error : Details of Validation Error ` |
134+ | http code | content-type | response |
135+ |---------------|-----------------------------------|---------------------------------------------------------------------|
136+ | ` 200 ` | ` application/ json` | ` Successful Validation` |
137+ | ` 422 ` | ` application/ json` | ` Error : Details of Validation Error ` |
138138
139139##### Example cURL
140140
141- > ` ` ` javascript
142- > curl - X ' POST' \
143- > ' http://localhost:5001/v1/ro_crates/validate_metadata' \
144- > - H ' accept: application/json' \
145- > - H ' Content-Type: application/json' \
146- > - d ' {
147- > "crate_json": "{' \' ' test1' \' ' : ' \' ' test2' \' ' }"
148- > }'
149- > ```
141+ ` ` ` javascript
142+ curl - X ' POST' \
143+ ' http://localhost:5001/v1/ro_crates/validate_metadata' \
144+ - H ' accept: application/json' \
145+ - H ' Content-Type: application/json' \
146+ - d ' {
147+ "crate_json": "{' \' ' test1' \' ' : ' \' ' test2' \' ' }"
148+ }'
149+ ```
150150
151151</details>
152152
153153
154-
155- ## Project Structure
156-
157- ```
158- app/
159- βββ ro_crates/
160- β βββ routes/
161- β β βββ __init__.py # Registers blueprints
162- β β βββ post_routes.py # POST API routes
163- β βββ __init__.py
164- βββ services/
165- β βββ logging_service.py # Centralised logging
166- β βββ validation_service.py # Queue RO-Crates for validation
167- βββ tasks/
168- β βββ validation_tasks.py # Validate RO-Crates
169- βββ utils/
170- β βββ config.py # Configuration
171- β βββ minio_utils.py # Methods for interacting with MinIO
172- β βββ webhook_utils.py # Methods for sending webhooks
173- ```
174-
175154## Setting up the project
176155
177156### Prerequisites
@@ -217,3 +196,23 @@ For testing locally developed containers use the alternate Docker Compose file:
217196```bash
218197 docker compose --file docker-compose-develop.yml up --build
219198```
199+
200+ ### Project Structure
201+
202+ ```
203+ app/
204+ βββ ro_crates/
205+ β βββ routes/
206+ β β βββ __init__.py # Registers blueprints
207+ β β βββ post_routes.py # POST API routes
208+ β βββ __init__.py
209+ βββ services/
210+ β βββ logging_service.py # Centralised logging
211+ β βββ validation_service.py # Queue RO-Crates for validation
212+ βββ tasks/
213+ β βββ validation_tasks.py # Validate RO-Crates
214+ βββ utils/
215+ β βββ config.py # Configuration
216+ β βββ minio_utils.py # Methods for interacting with MinIO
217+ β βββ webhook_utils.py # Methods for sending webhooks
218+ ```
0 commit comments