Skip to content
Snippets Groups Projects
Commit 05c45f6a authored by Jean-Paul Calderone's avatar Jean-Paul Calderone
Browse files

remove some redundancy in the specification

parent a855156f
No related branches found
No related tags found
1 merge request!293Design document for replication and recovery system
......@@ -296,8 +296,46 @@ The recovery process is as follows:
External Interfaces
-------------------
Specification
~~~~~~~~~~~~~
See the `OpenAPI specification <backup-recovery-openapi.html>`_.
Sample Sessions
~~~~~~~~~~~~~~~
The expected interaction pattern involves two API calls.
#. Early in the Tahoe-LAFS client node setup/configuration process,
configure replication:
.. code-block:: html
POST /storage-plugins/privatestorageio-zkapauthz-v1/replicate
201 Created
Content-Type: application/json
{"recovery-capability": "URI:DIR-RO:xxxx"}
#. After losing the Tahoe-LAFS node,
create a new Tahoe-LAFS client node and recover from the replica:
.. code-block:: html
POST /storage-plugins/privatestorageio-zkapauthz-v1/recover
Content-Type: application/json
Content-Length: ...
{"recovery-capability": "URI:DIR-RO:xxxx"}
200 OK
Data Integrity
--------------
......
......@@ -19,13 +19,8 @@ paths:
content:
application/json:
schema:
properties:
recovery-capability:
type: "string"
description: >-
The Tahoe-LAFS read-only capability for the recovery data.
This is the capability which can be submitted in order to
initiate a recovery from the replica.
"$ref": "/components/schemas/ReplicaConfiguration"
responses:
"500": # INTERNAL SERVER ERROR
description: >-
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment