Changeset View
Changeset View
Standalone View
Standalone View
swh/web/api/views/vault.py
| Show First 20 Lines • Show All 76 Lines • ▼ Show 20 Lines | .. http:post:: /api/1/vault/directory/(dir_id)/ | ||||
| (either **new**, **pending**, **done** or **failed**) | (either **new**, **pending**, **done** or **failed**) | ||||
| :>json string obj_id: the identifier of the object to cook | :>json string obj_id: the identifier of the object to cook | ||||
| **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 directory identifier has been provided | :statuscode 400: an invalid directory identifier has been provided | ||||
| :statuscode 404: requested directory can not be found in the archive | :statuscode 404: requested directory did not receive any cooking | ||||
anlambert: Indeed, this is the meaning of the 404 code in case of a GET request:
```
15:39 $ curl http… | |||||
| request yet | |||||
| """ | """ | ||||
| _, obj_id = query.parse_hash_with_algorithms_or_throws( | _, obj_id = query.parse_hash_with_algorithms_or_throws( | ||||
| dir_id, ['sha1'], 'Only sha1_git is supported.') | dir_id, ['sha1'], 'Only sha1_git is supported.') | ||||
| res = _dispatch_cook_progress(request, 'directory', obj_id) | res = _dispatch_cook_progress(request, 'directory', obj_id) | ||||
| res['fetch_url'] = reverse('api-1-vault-fetch-directory', | res['fetch_url'] = reverse('api-1-vault-fetch-directory', | ||||
| url_args={'dir_id': dir_id}) | url_args={'dir_id': dir_id}) | ||||
| return res | return res | ||||
| Show All 16 Lines | .. http:get:: /api/1/vault/directory/(dir_id)/raw/ | ||||
| :resheader Content-Type: application/octet-stream | :resheader Content-Type: application/octet-stream | ||||
| **Allowed HTTP Methods:** :http:method:`get`, :http:method:`head`, | **Allowed HTTP Methods:** :http:method:`get`, :http:method:`head`, | ||||
| :http:method:`options` | :http:method:`options` | ||||
| :statuscode 200: no error | :statuscode 200: no error | ||||
| :statuscode 400: an invalid directory identifier has been provided | :statuscode 400: an invalid directory identifier has been provided | ||||
| :statuscode 404: requested directory can not be found in the archive | :statuscode 404: requested directory did not receive any cooking | ||||
| request yet | |||||
| """ | """ | ||||
| _, obj_id = query.parse_hash_with_algorithms_or_throws( | _, obj_id = query.parse_hash_with_algorithms_or_throws( | ||||
| dir_id, ['sha1'], 'Only sha1_git is supported.') | dir_id, ['sha1'], 'Only sha1_git is supported.') | ||||
| res = api_lookup( | res = api_lookup( | ||||
| service.vault_fetch, 'directory', obj_id, | service.vault_fetch, 'directory', obj_id, | ||||
| notfound_msg="Directory with ID '{}' not found.".format(dir_id)) | notfound_msg="Directory with ID '{}' not found.".format(dir_id)) | ||||
| fname = '{}.tar.gz'.format(dir_id) | fname = '{}.tar.gz'.format(dir_id) | ||||
| response = HttpResponse(res, content_type='application/gzip') | response = HttpResponse(res, content_type='application/gzip') | ||||
| ▲ Show 20 Lines • Show All 47 Lines • ▼ Show 20 Lines | .. http:post:: /api/1/vault/revision/(rev_id)/gitfast/ | ||||
| :>json string status: the cooking task status (new/pending/done/failed) | :>json string status: the cooking task status (new/pending/done/failed) | ||||
| :>json string obj_id: the identifier of the object to cook | :>json string obj_id: the identifier of the object to cook | ||||
| **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 revision identifier has been provided | :statuscode 400: an invalid revision identifier has been provided | ||||
| :statuscode 404: requested revision can not be found in the archive | :statuscode 404: requested revision did not receive any cooking | ||||
| request yet | |||||
| """ | """ | ||||
| _, obj_id = query.parse_hash_with_algorithms_or_throws( | _, obj_id = query.parse_hash_with_algorithms_or_throws( | ||||
| rev_id, ['sha1'], 'Only sha1_git is supported.') | rev_id, ['sha1'], 'Only sha1_git is supported.') | ||||
| res = _dispatch_cook_progress(request, 'revision_gitfast', obj_id) | res = _dispatch_cook_progress(request, 'revision_gitfast', obj_id) | ||||
| res['fetch_url'] = reverse('api-1-vault-fetch-revision_gitfast', | res['fetch_url'] = reverse('api-1-vault-fetch-revision_gitfast', | ||||
| url_args={'rev_id': rev_id}) | url_args={'rev_id': rev_id}) | ||||
| return res | return res | ||||
| Show All 16 Lines | .. http:get:: /api/1/vault/revision/(rev_id)/gitfast/raw/ | ||||
| :resheader Content-Type: application/octet-stream | :resheader Content-Type: application/octet-stream | ||||
| **Allowed HTTP Methods:** :http:method:`get`, :http:method:`head`, | **Allowed HTTP Methods:** :http:method:`get`, :http:method:`head`, | ||||
| :http:method:`options` | :http:method:`options` | ||||
| :statuscode 200: no error | :statuscode 200: no error | ||||
| :statuscode 400: an invalid revision identifier has been provided | :statuscode 400: an invalid revision identifier has been provided | ||||
| :statuscode 404: requested revision can not be found in the archive | :statuscode 404: requested revision did not receive any cooking | ||||
| request yet | |||||
| """ | """ | ||||
| _, obj_id = query.parse_hash_with_algorithms_or_throws( | _, obj_id = query.parse_hash_with_algorithms_or_throws( | ||||
| rev_id, ['sha1'], 'Only sha1_git is supported.') | rev_id, ['sha1'], 'Only sha1_git is supported.') | ||||
| res = api_lookup( | res = api_lookup( | ||||
| service.vault_fetch, 'revision_gitfast', obj_id, | service.vault_fetch, 'revision_gitfast', obj_id, | ||||
| notfound_msg="Revision with ID '{}' not found.".format(rev_id)) | notfound_msg="Revision with ID '{}' not found.".format(rev_id)) | ||||
| fname = '{}.gitfast.gz'.format(rev_id) | fname = '{}.gitfast.gz'.format(rev_id) | ||||
| response = HttpResponse(res, content_type='application/gzip') | response = HttpResponse(res, content_type='application/gzip') | ||||
| Show All 17 Lines | |||||
Indeed, this is the meaning of the 404 code in case of a GET request:
15:39 $ curl http://localhost:5004/api/1/vault/directory/b1483f0996e94c0c80fc76e5ef0f760fbe9a491b/ | jq % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 945 100 945 0 0 37800 0 --:--:-- --:--:-- --:--:-- 37800 { "exception": "NotFoundExc", "reason": "Directory 'b1483f0996e94c0c80fc76e5ef0f760fbe9a491b' was never requested.", "traceback": "Traceback (most recent call last):\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/apidoc.py\", line 315, in documented_view\n response = f(request, **kwargs)\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/views/vault.py\", line 90, in api_vault_cook_directory\n res = _dispatch_cook_progress(request, 'directory', obj_id)\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/views/vault.py\", line 26, in _dispatch_cook_progress\n .format(object_name, hex_id)))\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/views/utils.py\", line 47, in api_lookup\n raise NotFoundExc(notfound_msg)\nswh.web.common.exc.NotFoundExc: Directory 'b1483f0996e94c0c80fc76e5ef0f760fbe9a491b' was never requested.\n" }But in case of a POST request, the 404 code really means that the directory is not archived:
15:38 $ curl -X POST http://localhost:5004/api/1/vault/directory/b1483f0996e94c0c80fc76e5ef0f760fbe9a491b/ | jq % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 925 100 925 0 0 23125 0 --:--:-- --:--:-- --:--:-- 23125 { "exception": "NotFoundExc", "reason": "Directory 'b1483f0996e94c0c80fc76e5ef0f760fbe9a491b' not found.", "traceback": "Traceback (most recent call last):\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/apidoc.py\", line 315, in documented_view\n response = f(request, **kwargs)\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/views/vault.py\", line 90, in api_vault_cook_directory\n res = _dispatch_cook_progress(request, 'directory', obj_id)\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/views/vault.py\", line 32, in _dispatch_cook_progress\n .format(object_name, hex_id)))\n File \"/srv/softwareheritage/venv/lib/python3.7/site-packages/swh/web/api/views/utils.py\", line 47, in api_lookup\n raise NotFoundExc(notfound_msg)\nswh.web.common.exc.NotFoundExc: Directory 'b1483f0996e94c0c80fc76e5ef0f760fbe9a491b' not found.\n" }So to be exhaustive in the doc, both cases should be present.