Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: markup JSON and HTTP API as any role

Browse Source 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2019-12-11 13:05:39 +01:00
parent 4102834167
commit 09e842f199
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/tutorial/tutorial05.rst
+9 -9
View File
@@ -29,7 +29,7 @@ Sharing the Stats
**Senior**
We have to provide a new endpoint to serve the same data but in JSON
We have to provide a new endpoint to serve the same data but in :any:`JSON`
format.
**Junior**
@@ -46,7 +46,7 @@ Sharing the Stats
**Senior**
For starters, that's not valid ``JSON``. The output would be something like:
For starters, that's not valid :any:`JSON`. The output would be something like:
.. code-block:: console
@@ -55,7 +55,7 @@ Sharing the Stats
Mem: 31967 3121 21680 980 7166 27418
Swap: 0 0 0"}
You can't add new lines inside a ``JSON`` string that way, you have to escape
You can't add new lines inside a :any:`JSON` string that way, you have to escape
the new line characters as ``\n``.
**Junior**
@@ -77,15 +77,15 @@ Sharing the Stats
**Senior**
:program:`jq` is a wonderful tool for working with ``JSON`` data from the command
line. With :program:`jq` you can extract data from a ``JSON`` document and it also
allows you to generate a well-formed ``JSON`` document.
:program:`jq` is a wonderful tool for working with :any:`JSON` data from the command
line. With :program:`jq` you can extract data from a :any:`JSON` document and it also
allows you to generate a well-formed :any:`JSON` document.
**Junior**
Let's use it, then!
How can we generate a ``JSON`` document with :program:`jq`?
How can we generate a :any:`JSON` document with :program:`jq`?
**Senior**
@@ -104,7 +104,7 @@ Sharing the Stats
**Senior**
Bear with me, it gets better. You can add variables to the ``JSON`` and
Bear with me, it gets better. You can add variables to the :any:`JSON` and
:program:`jq` will escape them for you.
.. code-block:: console
@@ -165,7 +165,7 @@ Sharing the Stats
**Junior**
I don't think so! the ``JSON`` is well-formed and it contains all the required
I don't think so! the :any:`JSON` is well-formed and it contains all the required
data. And the code is quite readable.
**Senior**