Changeset View
Changeset View
Standalone View
Standalone View
swh/web/api/views/origin_save.py
Show First 20 Lines • Show All 79 Lines • ▼ Show 20 Lines | .. http:post:: /api/1/origin/save/(visit_type)/url/(origin_url)/ | ||||
:>json string save_task_status: the status of the origin saving task, | :>json string save_task_status: the status of the origin saving task, | ||||
either **not created**, **not yet scheduled**, **scheduled**, | either **not created**, **not yet scheduled**, **scheduled**, | ||||
**succeeded** or **failed** | **succeeded** or **failed** | ||||
:>json string visit_date: the date (in iso format) of the visit if a visit | :>json string visit_date: the date (in iso format) of the visit if a visit | ||||
occurred, null otherwise. | occurred, null otherwise. | ||||
:>json string visit_status: the status of the visit, either **full**, | :>json string visit_status: the status of the visit, either **full**, | ||||
**partial**, **not_found** or **failed** if a visit occurred, null | **partial**, **not_found** or **failed** if a visit occurred, null | ||||
otherwise. | otherwise. | ||||
:>json string note: optional note giving details about the save request, | |||||
for instance why it has been rejected | |||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: an invalid visit type or origin url has been provided | :statuscode 400: an invalid visit type or origin url has been provided | ||||
:statuscode 403: the provided origin url is blacklisted | :statuscode 403: the provided origin url is blacklisted | ||||
:statuscode 404: no save requests have been found for a given origin | :statuscode 404: no save requests have been found for a given origin | ||||
""" | """ | ||||
Show All 16 Lines |