[lxc-devel] [lxd/master] Document image refresh API call.

[albertodonato on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 301 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20170531/3cb20b1f/attachment.bin>
-------------- next part --------------
From 452ab117d9e8151c004ca4bb28b090b2e4de7410 Mon Sep 17 00:00:00 2001
From: Alberto Donato <alberto.donato at canonical.com>
Date: Wed, 31 May 2017 09:42:06 +0200
Subject: [PATCH] Document image refresh API call.

Signed-off-by: Alberto Donato <alberto.donato at canonical.com>
---
 doc/rest-api.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/rest-api.md b/doc/rest-api.md
index 8b92db39f..f35873419 100644
--- a/doc/rest-api.md
+++ b/doc/rest-api.md
@@ -194,6 +194,7 @@ won't work and PUT needs to be used instead.
      * /1.0/images
        * /1.0/images/\<fingerprint\>
          * /1.0/images/\<fingerprint\>/export
+         * /1.0/images/\<fingerprint\>/refresh
        * /1.0/images/aliases
          * /1.0/images/aliases/\<name\>
      * /1.0/networks
@@ -1419,6 +1420,15 @@ client will POST to /1.0/images/\<fingerprint\>/export to get a secret
 token which it'll then pass to the target LXD. That target LXD will then
 GET the image as a guest, passing the secret token.
 
+## /1.0/images/\<fingerprint\>/refresh
+### POST
+ * Description: Refresh an image from its origin
+ * Authentication: trusted
+ * Operation: async
+ * Return: Background operation or standard error
+ 
+This creates an operation to refresh the specified image from its origin.
+
 ## /1.0/images/\<fingerprint\>/secret
 ### POST
  * Description: Generate a random token and tell LXD to expect it be used by a guest