Skip to content

Commit d79b388

Browse files
douglowedouglowe
committed
removed more indenting
1 parent 70d91c6 commit d79b388

File tree

1 file changed

+58
-58
lines changed

1 file changed

+58
-58
lines changed

‎README.md‎

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ This project presents a Flask-based API for validating RO-Crates.
1111

1212
##### Path Parameters
1313

14-
> | name | type | data type | description |
15-
> |------------|-----------|-------------------------|-----------------------------------------------------------------------|
16-
> | crate_id | required | string | RO-Crate identifer string |
14+
| name | type | data type | description |
15+
|------------|-----------|-------------------------|-----------------------------------------------------------------------|
16+
| crate_id | required | string | RO-Crate identifer string |
1717

1818
##### Parameters
1919

20-
> | name | type | data type | description |
21-
> |------------|-----------|-------------------------|-----------------------------------------------------------------------|
22-
> | root_path | optional | string | Root path which contains the RO-Crate |
23-
> | webhook_url | optional | string | Webhook to send validation result to |
24-
> | minio_config | required | dictionary | MinIO Configuration Details |
20+
| name | type | data type | description |
21+
|------------|-----------|-------------------------|-----------------------------------------------------------------------|
22+
| root_path | optional | string | Root path which contains the RO-Crate |
23+
| webhook_url | optional | string | Webhook to send validation result to |
24+
| minio_config | required | dictionary | MinIO Configuration Details |
2525

2626
`minio_config`
2727
> | name | type | data type | description |
@@ -34,29 +34,29 @@ This project presents a Flask-based API for validating RO-Crates.
3434
3535
##### Responses
3636

37-
> | http code | content-type | response |
38-
> |---------------|-----------------------------------|---------------------------------------------------------------------|
39-
> | `202` | `application/json` | `{"message": "Validation in progress"}` |
40-
> | `400` | `application/json` | `{"message": "No RO-Crate with prefix: <crate_id>"}` |
41-
> | `500` | `application/json` | `{"message": "Internal server errors"}` |
42-
43-
> ```javascript
44-
> curl -X 'POST' \
45-
> 'http://localhost:5001/v1/ro_crates/<crate_id>/validation' \
46-
> -H 'accept: application/json' \
47-
> -H 'Content-Type: application/json' \
48-
> -d '{
49-
> "minio_config": {
50-
> "accesskey": "<key>",
51-
> "bucket": "ro-crates",
52-
> "endpoint": "minio:9000",
53-
> "secret": "<secret>",
54-
> "ssl": false
55-
> },
56-
> "profile_name": "<profile>",
57-
> "webhook_url": "<webhook>"
58-
> }'
59-
> ```
37+
| http code | content-type | response |
38+
|---------------|-----------------------------------|---------------------------------------------------------------------|
39+
| `202` | `application/json` | `{"message": "Validation in progress"}` |
40+
| `400` | `application/json` | `{"message": "No RO-Crate with prefix: <crate_id>"}` |
41+
| `500` | `application/json` | `{"message": "Internal server errors"}` |
42+
43+
```javascript
44+
curl -X 'POST' \
45+
'http://localhost:5001/v1/ro_crates/<crate_id>/validation' \
46+
-H 'accept: application/json' \
47+
-H 'Content-Type: application/json' \
48+
-d '{
49+
"minio_config": {
50+
"accesskey": "<key>",
51+
"bucket": "ro-crates",
52+
"endpoint": "minio:9000",
53+
"secret": "<secret>",
54+
"ssl": false
55+
},
56+
"profile_name": "<profile>",
57+
"webhook_url": "<webhook>"
58+
}'
59+
```
6060

6161
</details>
6262

@@ -68,16 +68,16 @@ This project presents a Flask-based API for validating RO-Crates.
6868

6969
##### Path Parameters
7070

71-
> | name | type | data type | description |
72-
> |------------|-----------|-------------------------|-----------------------------------------------------------------------|
73-
> | crate_id | required | string | RO-Crate identifer string |
71+
| name | type | data type | description |
72+
|------------|-----------|-------------------------|-----------------------------------------------------------------------|
73+
| crate_id | required | string | RO-Crate identifer string |
7474

7575
##### Parameters
7676

77-
> | name | type | data type | description |
78-
> |------------|-----------|-------------------------|-----------------------------------------------------------------------|
79-
> | root_path | optional | string | Root path which contains the RO-Crate |
80-
> | minio_config | required | dictionary | MinIO Configuration Details |
77+
| name | type | data type | description |
78+
|------------|-----------|-------------------------|-----------------------------------------------------------------------|
79+
| root_path | optional | string | Root path which contains the RO-Crate |
80+
| minio_config | required | dictionary | MinIO Configuration Details |
8181

8282
`minio_config`
8383
> | name | type | data type | description |
@@ -90,29 +90,29 @@ This project presents a Flask-based API for validating RO-Crates.
9090
9191
##### Responses
9292

93-
> | http code | content-type | response |
94-
> |---------------|-----------------------------------|---------------------------------------------------------------------|
95-
> | `200` | `application/json` | `Successful Validation` |
96-
> | `422` | `application/json` | `Error: Details of Validation Error` |
97-
> | `404` | `application/json` | `Not found` |
93+
| http code | content-type | response |
94+
|---------------|-----------------------------------|---------------------------------------------------------------------|
95+
| `200` | `application/json` | `Successful Validation` |
96+
| `422` | `application/json` | `Error: Details of Validation Error` |
97+
| `404` | `application/json` | `Not found` |
9898

9999
##### Example cURL
100100

101-
> ```javascript
102-
> curl -X 'GET' \
103-
> 'http://localhost:5001/v1/ro_crates/<crate_id>/validation' \
104-
> -H 'accept: application/json' \
105-
> -H 'Content-Type: application/json' \
106-
> -d '{
107-
> "minio_config": {
108-
> "accesskey": "<key>",
109-
> "bucket": "ro-crates",
110-
> "endpoint": "minio:9000",
111-
> "secret": "<secret>",
112-
> "ssl": false
113-
> }
114-
> }'
115-
> ```
101+
```javascript
102+
curl -X 'GET' \
103+
'http://localhost:5001/v1/ro_crates/<crate_id>/validation' \
104+
-H 'accept: application/json' \
105+
-H 'Content-Type: application/json' \
106+
-d '{
107+
"minio_config": {
108+
"accesskey": "<key>",
109+
"bucket": "ro-crates",
110+
"endpoint": "minio:9000",
111+
"secret": "<secret>",
112+
"ssl": false
113+
}
114+
}'
115+
```
116116

117117
</details>
118118

0 commit comments

Comments
 (0)