Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
docs-action committed Nov 15, 2023
1 parent 216a1e7 commit 2aca0fc
Show file tree
Hide file tree
Showing 3 changed files with 175 additions and 4 deletions.
2 changes: 1 addition & 1 deletion assets/js/search-data.json

Large diffs are not rendered by default.

166 changes: 166 additions & 0 deletions assets/js/swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,53 @@ components:
ref:
type: string

TaskInfo:
type: object
required:
- id
properties:
id:
type: string
description: ID of the task

RepositoryDumpStatus:
type: object
required:
- id
- done
- update_time
properties:
id:
type: string
description: ID of the task
done:
type: boolean
update_time:
type: string
format: date-time
error:
type: string
refs:
$ref: "#/components/schemas/RefsDump"

RepositoryRestoreStatus:
type: object
required:
- id
- done
- update_time
properties:
id:
type: string
description: ID of the task
done:
type: boolean
update_time:
type: string
format: date-time
error:
type: string

RefsDump:
type: object
required:
Expand Down Expand Up @@ -2686,6 +2733,125 @@ paths:
default:
$ref: "#/components/responses/ServerError"


/repositories/{repository}/dump:
parameters:
- in: path
name: repository
required: true
schema:
type: string
post:
tags:
- repositories
operationId: dumpSubmit
summary: Backup the repository metadata (tags, commits, branches) and save the backup to the object store.
responses:
202:
description: dump task information
content:
application/json:
schema:
$ref: "#/components/schemas/TaskInfo"
400:
$ref: "#/components/responses/ValidationError"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/ServerError"
get:
tags:
- repositories
operationId: dumpStatus
summary: Status of a repository dump task
parameters:
- in: query
name: task_id
required: true
schema:
type: string
responses:
200:
description: dump task status
content:
application/json:
schema:
$ref: "#/components/schemas/RepositoryDumpStatus"
400:
$ref: "#/components/responses/ValidationError"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
420:
description: too many requests
default:
$ref: "#/components/responses/ServerError"

/repositories/{repository}/restore:
parameters:
- in: path
name: repository
required: true
schema:
type: string
post:
tags:
- repositories
operationId: restoreSubmit
summary: Restore repository from a dump in the object store
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RefsDump"
responses:
202:
description: restore task created
content:
application/json:
schema:
$ref: "#/components/schemas/TaskInfo"
400:
$ref: "#/components/responses/ValidationError"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/ServerError"
get:
tags:
- repositories
operationId: restoreStatus
summary: Status of a restore request
parameters:
- in: query
name: task_id
required: true
schema:
type: string
responses:
200:
description: restore task status
content:
application/json:
schema:
$ref: "#/components/schemas/RepositoryRestoreStatus"
400:
$ref: "#/components/responses/ValidationError"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
420:
description: too many requests
default:
$ref: "#/components/responses/ServerError"

/repositories/{repository}/tags:
parameters:
- in: path
Expand Down
11 changes: 8 additions & 3 deletions reference/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -4729,7 +4729,10 @@ <h4 class="no_toc" id="options-130">
</h4>


<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> -h, --help help for refs-dump
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> -h, --help help for refs-dump
-o, --output string output filename (default stdout)
--poll-interval duration poll status check interval (default 3s)
--timeout duration timeout for polling status checks (default 1h0m0s)
</code></pre></div></div>
<h3 id="lakectl-refs-restore">

Expand Down Expand Up @@ -4779,8 +4782,10 @@ <h4 class="no_toc" id="options-131">
</h4>


<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> -h, --help help for refs-restore
--manifest refs-dump path to a refs manifest json file (as generated by refs-dump). Alternatively, use "-" to read from stdin
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> -h, --help help for refs-restore
--manifest refs-dump path to a refs manifest json file (as generated by refs-dump). Alternatively, use "-" to read from stdin
--poll-interval duration poll status check interval (default 3s)
--timeout duration timeout for polling status checks (default 1h0m0s)
</code></pre></div></div>
<h3 id="lakectl-repo">

Expand Down

0 comments on commit 2aca0fc

Please sign in to comment.