[lxc-devel] [lxd/master] Escaping path params in docs

[andygreenegrass on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 424 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20170731/77e19bcb/attachment.bin>
-------------- next part --------------
From 8d443e3f81a36b32caed05b6339dc3168f6c1e1d Mon Sep 17 00:00:00 2001
From: Andy Greene <andygreenegrass at gmail.com>
Date: Sun, 30 Jul 2017 22:28:35 -0400
Subject: [PATCH] escaping path params in docs

Signed-off-by: Andy Greene <andygreenegrass at gmail.com>
---
 doc/api-extensions.md | 36 ++++++++++++++++++------------------
 doc/rest-api.md       |  8 ++++----
 2 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/doc/api-extensions.md b/doc/api-extensions.md
index 4550b7d72..089cbc067 100644
--- a/doc/api-extensions.md
+++ b/doc/api-extensions.md
@@ -112,9 +112,9 @@ This includes:
  * Addition of the "managed" property on /1.0/networks entries
  * All the network configuration options (see configuration.md for details)
  * POST /1.0/networks (see rest-api.md for details)
- * PUT /1.0/networks/<entry> (see rest-api.md for details)
- * PATCH /1.0/networks/<entry> (see rest-api.md for details)
- * DELETE /1.0/networks/<entry> (see rest-api.md for details)
+ * PUT /1.0/networks/\<entry\> (see rest-api.md for details)
+ * PATCH /1.0/networks/\<entry\> (see rest-api.md for details)
+ * DELETE /1.0/networks/\<entry\> (see rest-api.md for details)
  * ipv4.address property on "nic" type devices (when nictype is "bridged")
  * ipv6.address property on "nic" type devices (when nictype is "bridged")
  * security.mac\_filtering property on "nic" type devices (when nictype is "bridged")
@@ -130,7 +130,7 @@ server and operate in pull mode.
 
 ## container\_exec\_recording
 Introduces a new boolean "record-output", parameter to
-/1.0/containers/<name>/exec which when set to "true" and combined with
+/1.0/containers/\<name\>/exec which when set to "true" and combined with
 with "wait-for-websocket" set to false, will record stdout and stderr to
 disk and make them available through the logs interface.
 
@@ -146,7 +146,7 @@ Adds the following to the REST API:
  * PATCH of certificate entries
 
 ## container\_exec\_signal\_handling
-Adds support /1.0/containers/<name>/exec for forwarding signals sent to the
+Adds support /1.0/containers/\<name\>/exec for forwarding signals sent to the
 client to the processes executing in the container. Currently SIGTERM and
 SIGHUP are forwarded. Further signals that can be forwarded might be added
 later.
@@ -184,22 +184,22 @@ This includes:
 * GET /1.0/storage-pools
 * POST /1.0/storage-pools (see rest-api.md for details)
 
-* GET /1.0/storage-pools/<name> (see rest-api.md for details)
-* POST /1.0/storage-pools/<name> (see rest-api.md for details)
-* PUT /1.0/storage-pools/<name> (see rest-api.md for details)
-* PATCH /1.0/storage-pools/<name> (see rest-api.md for details)
-* DELETE /1.0/storage-pools/<name> (see rest-api.md for details)
+* GET /1.0/storage-pools/\<name\> (see rest-api.md for details)
+* POST /1.0/storage-pools/\<name\> (see rest-api.md for details)
+* PUT /1.0/storage-pools/\<name\> (see rest-api.md for details)
+* PATCH /1.0/storage-pools/\<name\> (see rest-api.md for details)
+* DELETE /1.0/storage-pools/\<name\> (see rest-api.md for details)
 
-* GET /1.0/storage-pools/<name>/volumes (see rest-api.md for details)
+* GET /1.0/storage-pools/\<name\>/volumes (see rest-api.md for details)
 
-* GET /1.0/storage-pools/<name>/volumes/<volume_type> (see rest-api.md for details)
-* POST /1.0/storage-pools/<name>/volumes/<volume_type> (see rest-api.md for details)
+* GET /1.0/storage-pools/\<name\>/volumes/\<volume_type\> (see rest-api.md for details)
+* POST /1.0/storage-pools/\<name\>/volumes/\<volume_type\> (see rest-api.md for details)
 
-* GET /1.0/storage-pools/<pool>/volumes/<volume_type>/<name> (see rest-api.md for details)
-* POST /1.0/storage-pools/<pool>/volumes/<volume_type>/<name> (see rest-api.md for details)
-* PUT /1.0/storage-pools/<pool>/volumes/<volume_type>/<name> (see rest-api.md for details)
-* PATCH /1.0/storage-pools/<pool>/volumes/<volume_type>/<name> (see rest-api.md for details)
-* DELETE /1.0/storage-pools/<pool>/volumes/<volume_type>/<name> (see rest-api.md for details)
+* GET /1.0/storage-pools/\<pool\>/volumes/\<volume_type\>/\<name\> (see rest-api.md for details)
+* POST /1.0/storage-pools/\<pool\>/volumes/\<volume_type\>/\<name\> (see rest-api.md for details)
+* PUT /1.0/storage-pools/\<pool\>/volumes/\<volume_type\>/\<name\> (see rest-api.md for details)
+* PATCH /1.0/storage-pools/\<pool\>/volumes/\<volume_type\>/\<name\> (see rest-api.md for details)
+* DELETE /1.0/storage-pools/\<pool\>/volumes/\<volume_type\>/\<name\> (see rest-api.md for details)
 
 - All storage configuration options (see configuration.md for details)
 
diff --git a/doc/rest-api.md b/doc/rest-api.md
index 5f91ff4ef..b5c8f9a9c 100644
--- a/doc/rest-api.md
+++ b/doc/rest-api.md
@@ -2054,7 +2054,7 @@ Input:
         "name": "pool1"
     }
 
-## /1.0/storage-pools/<name>
+## /1.0/storage-pools/\<name\>
 ### GET
  * Description: information about a storage pool
  * Introduced: with API extension "storage"
@@ -2152,7 +2152,7 @@ Input (none at present):
     {
     }
 
-## /1.0/storage-pools/<name>/volumes
+## /1.0/storage-pools/\<name\>/volumes
 ### GET
  * Description: list of storage volumes
  * Introduced: with API extension "storage"
@@ -2184,7 +2184,7 @@ Input (none at present):
         "/1.0/storage-pools/default/volumes/images/62e850a334bb9d99cac00b2e618e0291e5e7bb7db56c4246ecaf8e46fa0631a6"
     ]
 
-## /1.0/storage-pools/<pool>/volumes
+## /1.0/storage-pools/\<pool\>/volumes
 ### GET
  * Description: list all storage volumes on a storage pool
  * Introduced: with API extension "storage"
@@ -2252,7 +2252,7 @@ Input:
     }
 
 
-## /1.0/storage-pools/<pool>/volumes/<type>/<name>
+## /1.0/storage-pools/\<pool\>/volumes/\<type\>/\<name\>
 ### GET
  * Description: information about a storage volume of a given type on a storage pool
  * Introduced: with API extension "storage"