Skip to content

Commit a7f3601

Browse files
committed
adjust docstring for post routes
1 parent f121879 commit a7f3601

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

app/ro_crates/routes/post_routes.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,19 @@ def validate_ro_crate_from_id(json_data) -> tuple[Response, int]:
2424
"""
2525
Endpoint to validate an RO-Crate using its ID from MinIO.
2626
27-
Parameters:
28-
- **crate_id**: The ID of the RO-Crate to validate. _Required_.
29-
- **profile_name**: The profile name for validation. _Optional_.
30-
- **webhook_url**: The webhook URL where validation results will be sent. _Required_.
27+
Args:
28+
crate_id:
29+
The ID of the RO-Crate to validate. _Required_.
30+
profile_name:
31+
The profile name for validation. _Optional_.
32+
webhook_url:
33+
The webhook URL where validation results will be sent. _Required_.
3134
3235
Returns:
33-
- A tuple containing the validation task's response and an HTTP status code.
36+
A tuple containing the validation task's response and an HTTP status code.
3437
3538
Raises:
36-
- KeyError: If required parameters (`crate_id` or `webhook_url`) are missing.
39+
KeyError: If required parameters (`crate_id` or `webhook_url`) are missing.
3740
"""
3841

3942
try:

0 commit comments

Comments
 (0)