Differential D2167 Diff 7412 swh/web/api/views/origin_save.py

Changeset View

Standalone View

swh/web/api/views/origin_save.py

# Copyright (C) 2018-2019 The Software Heritage developers		# Copyright (C) 2018-2019 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution		# See the AUTHORS file at the top-level directory of this distribution
# License: GNU Affero General Public License version 3, or any later version		# License: GNU Affero General Public License version 3, or any later version
# See top-level LICENSE file for more information		# See top-level LICENSE file for more information

from django.views.decorators.cache import never_cache		from django.views.decorators.cache import never_cache

from swh.web.api.apidoc import api_doc, format_docstring		from swh.web.api.apidoc import api_doc, format_docstring
from swh.web.api.apiurls import api_route		from swh.web.api.apiurls import api_route
from swh.web.common.origin_save import (		from swh.web.common.origin_save import (
create_save_origin_request, get_save_origin_requests		create_save_origin_request, get_save_origin_requests
)		)


@api_route(r'/origin/save/(?P<origin_type>.+)/url/(?P<origin_url>.+)/',		@api_route(r'/origin/save/(?P<visit_type>.+)/url/(?P<origin_url>.+)/',
'api-1-save-origin', methods=['GET', 'POST'],		'api-1-save-origin', methods=['GET', 'POST'],
throttle_scope='swh_save_origin')		throttle_scope='swh_save_origin')
@never_cache		@never_cache
@api_doc('/origin/save/')		@api_doc('/origin/save/')
@format_docstring()		@format_docstring()
def api_save_origin(request, origin_type, origin_url):		def api_save_origin(request, visit_type, origin_url):
"""		"""
.. http:get:: /api/1/origin/save/(origin_type)/url/(origin_url)/		.. http:get:: /api/1/origin/save/(visit_type)/url/(origin_url)/
.. http:post:: /api/1/origin/save/(origin_type)/url/(origin_url)/		.. http:post:: /api/1/origin/save/(visit_type)/url/(origin_url)/

Request the saving of a software origin into the archive		Request the saving of a software origin into the archive
or check the status of previously created save requests.		or check the status of previously created save requests.

That endpoint enables to create a saving task for a software origin		That endpoint enables to create a saving task for a software origin
through a POST request.		through a POST request.

Depending of the provided origin url, the save request can either be:		Depending of the provided origin url, the save request can either be:
Show All 14 Lines	.. http:post:: /api/1/origin/save/(visit_type)/url/(origin_url)/
* scheduled: the task execution has been scheduled		* scheduled: the task execution has been scheduled
* succeed: the saving task has been successfully executed		* succeed: the saving task has been successfully executed
* failed: the saving task has been executed but it failed		* failed: the saving task has been executed but it failed

When issuing a POST request an object will be returned while a GET		When issuing a POST request an object will be returned while a GET
request will return an array of objects (as multiple save requests		request will return an array of objects (as multiple save requests
might have been submitted for the same origin).		might have been submitted for the same origin).

:param string origin_type: the type of origin to save		:param string visit_type: the type of visit to perform
(currently the supported types are ``git``, ``hg`` and ``svn``)		(currently the supported types are ``git``, ``hg`` and ``svn``)
:param string origin_url: the url of the origin to save		:param string origin_url: the url of the origin to save

{common_headers}		{common_headers}

:>json string origin_url: the url of the origin to save		:>json string origin_url: the url of the origin to save
:>json string origin_type: the type of the origin to save		:>json string visit_type: the type of visit to perform
:>json string save_request_date: the date (in iso format) the save		:>json string save_request_date: the date (in iso format) the save
request was issued		request was issued
:>json string save_request_status: the status of the save request,		:>json string save_request_status: the status of the save request,
either accepted, rejected or pending		either accepted, rejected or pending
:>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,
succeed or failed		succeed or failed

Allowed HTTP Methods: :http:method:`get`, :http:method:`post`,		Allowed HTTP Methods: :http:method:`get`, :http:method:`post`,
:http:method:`head`, :http:method:`options`		:http:method:`head`, :http:method:`options`

:statuscode 200: no error		:statuscode 200: no error
:statuscode 400: an invalid origin type or 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
"""		"""

if request.method == 'POST':		if request.method == 'POST':
sor = create_save_origin_request(origin_type, origin_url)		sor = create_save_origin_request(visit_type, origin_url)
del sor['id']		del sor['id']
else:		else:
sor = get_save_origin_requests(origin_type, origin_url)		sor = get_save_origin_requests(visit_type, origin_url)
for s in sor: del s['id'] # noqa		for s in sor:
		del s['id']

return sor		return sor