Docs - add new features

This commit is contained in:
Sam
2023-03-04 17:49:02 +01:00
parent fbb539d584
commit f902313127
6 changed files with 107 additions and 30 deletions

View File

@ -1766,7 +1766,9 @@ def request_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
def get_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
"""
Get a data export info for authenticated user if a request exists.
It returns:
- export creation date
- export status ("in_progress", "successful" and "errored")
- file name and size (in bytes) when export is successful
@ -1780,13 +1782,13 @@ def get_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
**Example response**:
- if a request exists
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
- if a request exists:
{
"status": "success",
"request": {
@ -1797,7 +1799,12 @@ def get_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
}
}
- if no request:
- if no request
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",

View File

@ -111,7 +111,7 @@ def clean_export_archives(
'--max',
type=int,
required=True,
help='Maximum number of archives to generate.',
help='Maximum number of export requests to process.',
)
def export_archives(
max: int,