Skip to content

Commit 70d91c6

Browse files
committed
test alternate display
1 parent 5ea8bef commit 70d91c6

1 file changed

Lines changed: 37 additions & 38 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -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

Comments
Β (0)