summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2021-12-22 10:14:37 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2021-12-22 10:17:02 -0500
commit5ce7d9b7bcb4dae9fa27ff416b45f7cf77eff6ae (patch)
tree18f743e0c63efc7db6004c472e3bdd434f5142f1
parent6dce3d8fed0d8e59add1e09a46c0d1d5dd4f7f09 (diff)
downloaddocs-5ce7d9b7bcb4dae9fa27ff416b45f7cf77eff6ae.tar.gz
docs-5ce7d9b7bcb4dae9fa27ff416b45f7cf77eff6ae.tar.bz2
docs-5ce7d9b7bcb4dae9fa27ff416b45f7cf77eff6ae.zip
Convert ":http:host:ENDPOINT" syntax into simple "POST ENDPOINT" text
The :http:post:ENDPOINT syntax runs afoul of the limited httpdomain.py understanding of the optional parts of ENDPOINT. This results in warnings when building. One resolution to the problem is to make Sphinx (httpdomain.py) smarter. Another is to add all the combinations of the optional and non-optional ENDPOINT as anchors. Discussion starts here: <https://mail.gnu.org/archive/html/taler/2021-11/msg00013.html>. This change takes the third approach of avoiding the fancy syntax by using simple non-referential text.
-rw-r--r--taler-mcig.rst10
-rw-r--r--taler-nfc-guide.rst7
2 files changed, 9 insertions, 8 deletions
diff --git a/taler-mcig.rst b/taler-mcig.rst
index c69d838c..97de36e6 100644
--- a/taler-mcig.rst
+++ b/taler-mcig.rst
@@ -315,7 +315,7 @@ The fictitious store, Pretty Pianos, has only two products:
- pianos (physical good);
- *Beethoven Sonatas* (sheet music PDF files, digital good).
-M: :http:post:`/instances/default/private/products`
+M: POST ``/instances/default/private/products``
.. code-block:: javascript
@@ -338,7 +338,7 @@ field's list value.
This means the ``image`` value is *marked as forgettable*.
This will come into play later (see below).
-M: :http:post:`/instances/default/private/products`
+M: POST ``/instances/default/private/products``
.. code-block:: javascript
@@ -384,7 +384,7 @@ they need never pay again for it.
When the customer clicks on the product's "buy" button,
you first POST to ``/private/orders`` to create an order:
-M: :http:post:`/instances/default/private/orders`
+M: POST ``/instances/default/private/orders``
.. code-block:: javascript
@@ -425,7 +425,7 @@ Notes:
Now that there is an order in the system, the wallet *claims* the order.
-W: :http:post:`/orders/G93420934823/claim`
+W: POST ``/orders/G93420934823/claim``
.. code-block:: javascript
@@ -508,7 +508,7 @@ for the offer to time out).
The customer accepts the contract:
-W: :http:post:`/orders/G93420934823/pay`
+W: POST ``/orders/G93420934823/pay``
.. code-block:: javascript
diff --git a/taler-nfc-guide.rst b/taler-nfc-guide.rst
index 1b3cfb18..98b481c2 100644
--- a/taler-nfc-guide.rst
+++ b/taler-nfc-guide.rst
@@ -45,7 +45,7 @@ using `curl <https://curl.haxx.se/docs/manpage.html>`_ to make HTTP(S) requests.
can be opened, and give a warning if it is detected that the devices does not have Internet
connectivity.
- The following :http:post:`/private/orders` request to the merchant backend creates a
+ The following POST ``/private/orders`` request to the merchant backend creates a
simple order:
.. code-block:: console
@@ -69,7 +69,7 @@ using `curl <https://curl.haxx.se/docs/manpage.html>`_ to make HTTP(S) requests.
}
2. The merchant checks the payment status of the order using
- :http:get:`/private/orders/$ORDER_ID`:
+ GET ``/private/orders/$ORDER_ID``:
.. code-block:: console
@@ -135,7 +135,8 @@ using `curl <https://curl.haxx.se/docs/manpage.html>`_ to make HTTP(S) requests.
before responding with the fulfillment page.
For in-store payments, the merchant must periodically check the payment status.
- Instead of polling in a busy loop, the ``timeout_ms`` parameter of :http:get:`/private/orders/$ORDER_ID`
+ Instead of polling in a busy loop, the ``timeout_ms`` parameter
+ of GET ``/private/orders/$ORDER_ID``
should be used.