From 195399ccf5281e9118a82a7083c1913b53a1923b Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Sat, 3 Aug 2019 05:13:14 -0400
Subject: [PATCH] document what this branch actually does
---
docs/source/interface.rst | 14 ++++----------
1 file changed, 4 insertions(+), 10 deletions(-)
diff --git a/docs/source/interface.rst b/docs/source/interface.rst
index 1b3c854..e48f900 100644
--- a/docs/source/interface.rst
+++ b/docs/source/interface.rst
@@ -32,16 +32,10 @@ If the payment reference number is not known then the response is **NOT FOUND**.
For any payment reference number which has previously been submitted,
the response is **OK** with an ``application/json`` content-type response body like::
- {"stage": <integer>,
- "of": <integer>,
- "stage-name": <string>,
- "stage-entered-time": <iso8601 timestamp>
- }
-
-The ``stage`` property indicates how far into redemption the plugin has proceeded.
-The ``of`` property indicates how many steps the process involves in total.
-The ``stage-name`` property gives a human-meaningful description of the current stage.
-The ``stage-entered-time`` property gives the timestamp for the start of the current staged.
+ {"value": <string>}
+
+The ``value`` property merely indicates the payment reference number which was requested.
+Further properties will be added to this response in the near future.
``GET /storage-plugins/privatestorageio-satauthz-v1/payment-reference-number``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
GitLab