From 8f9d53ca9b7e505fcb3aae77ab10022bd67267fa Mon Sep 17 00:00:00 2001 From: Marcin Haba Date: Sat, 10 Jun 2017 18:30:31 +0200 Subject: [PATCH] baculum: Update api endpoints documentation about Bvfs --- docs/manuals/en/console/baculum.tex | 77 ++++++++++++++++++++--------- 1 file changed, 53 insertions(+), 24 deletions(-) diff --git a/docs/manuals/en/console/baculum.tex b/docs/manuals/en/console/baculum.tex index c606cbaf..141bde5f 100644 --- a/docs/manuals/en/console/baculum.tex +++ b/docs/manuals/en/console/baculum.tex @@ -620,7 +620,7 @@ POST /jobs/estimate/ - call estimate action on a job. +-----------------------------------------------------------------------------+ | /api/jobs/estimate/ POST request | +-------------------+---------+-----------------------------------------------+ -| Name | Type | Description | +| Name | Type | Description | +-------------------+---------+-----------------------------------------------+ | create[id] * | integer | job id to get job name for estimate purpose | | | | (used instead job name) | @@ -662,7 +662,7 @@ POST /jobs/run/ - call run action on job (run job). +-----------------------------------------------------------------------------+ | /api/jobs/run/ POST request | +-------------------+---------+-----------------------------------------------+ -| Name | Type | Description | +| Name | Type | Description | +-------------------+---------+-----------------------------------------------+ | create[id] * | integer | job id to get job name to run | | | | (used instead job name) | @@ -722,7 +722,7 @@ POST /jobs/restore/ - call restore action. +-----------------------------------------------------------------------------+ | /api/jobs/restore/ POST request | +-------------------+---------+-----------------------------------------------+ -| Name | Type | Description | +| Name | Type | Description | +-------------------+---------+-----------------------------------------------+ | create[rpath] * | string | Bvfs temporary table name for restore purpose | | | | in form: b2[0-9]+ | @@ -796,41 +796,70 @@ is b2[0-9]+. \subsection{Bvfs} -GET /api/bvfs/lsdirs/9/?path=\%2Fhome\%2F - listing from Bvfs cache directories -for jobid equal 9 and path equal /home/. URL-encoded path with ending slash -is necessary. +PUT /api/bvfs/lsdirs/ - listing from Bvfs cache directories + +PUT /api/bvfs/lsdirs/limit/250 - listing from Bvfs cache directories + limited to 250 elements. -GET /api/bvfs/lsdirs/9/limit/250/?path=\%2Fhome\%2f - listing from Bvfs cache -directories limited to 250 elements for jobid equal 9 and path equal /home/. -URL-encoded path with ending slash is necessary. +PUT /api/bvfs/lsdirs/limit/250/100/ - listing from Bvfs cache directories + limited to 250 elements with offset equal 100. + +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/bvfs/lsdirs/ PUT request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| update[jobids] * | string | Job identifiers separated by comma character | +| | | | ++-------------------+---------+-----------------------------------------------+ +| update[path] * | string | Path to list directories in Bvfs job cache | +| | | | ++-------------------+---------+-----------------------------------------------+ +\end{verbatim} -GET /api/bvfs/lsdirs/9/limit/250/100/?path=\%2fhome\%2f - listing from Bvfs -cache directories limited to 250 elements with offset equal 100 for jobid -equal 9 and path equal /home/. URL-encoded path with ending slash is necessary. +PUT /api/bvfs/lsfiles/ - listing from Bvfs cache files. -GET /api/bvfs/lsfiles/9/?path=\%2fhome\%2f - listing from Bvfs cache files for -jobid equal 9 and path equal /home/. URL-encoded path with ending slash is -necessary. +PUT /api/bvfs/lsfiles/limit/60/ - listing from Bvfs cache files limited + to 60 elements. -GET /api/bvfs/lsfiles/9/limit/60/?path=\%2fhome\%2f - listing from Bvfs cache -files limited to 60 elements for jobid equal 9 and path equal /home/. -URL-encoded path with ending slash is necessary. +PUT /api/bvfs/lsfiles/limit/120/60/ - listing from Bvfs cache files limited + to 120 elements with offset equal 60 -GET /api/bvfs/lsfiles/9/limit/120/60/?path=\%2fhome\%2f - listing from Bvfs -cache files limited to 120 elements with offset equal 60 for jobid equal -9 and path equal /home/. URL-encoded path with ending slash is necessary. +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/bvfs/lsfiles/ PUT request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| update[jobids] * | string | Job identifiers separated by comma character | +| | | | ++-------------------+---------+-----------------------------------------------+ +| update[path] * | string | Path to list directories in Bvfs job cache | +| | | | ++-------------------+---------+-----------------------------------------------+ +\end{verbatim} GET /api/bvfs/versions/abc-fd/123/456/789/ - listing from Bvfs cache all -files versions for client named abc-fd, for jobid equal 123, for pathid + files versions for client named abc-fd, for jobid equal 123, for pathid equal 456 and for filenameid equal 789. URL-encoded client name is necessary. GET /api/bvfs/getjobids/9/ - listing from Bvfs cache all elementary jobids which are necessary for restore all files from job with jobid equal 9 (eg. if jobid 9 is job type incremental or differential). -PUT /api/bvfs/update/9 - updating Bvfs cache for jobid equal 9. +PUT /api/bvfs/update/ - updating Bvfs cache for specific job. -PUT /api/bvfs/update/9,10,22 - updating Bvfs cache for jobids equal 9, 10 and 22. +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/bvfs/update/ PUT request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| update[jobids] * | string | Job identifiers separated by comma character | +| | | | ++-------------------+---------+-----------------------------------------------+ +\end{verbatim} POST /api/bvfs/restore/ - preparing Bvfs paths for restore command. -- 2.39.5