From 7cc15f331554e7e329d396275ba2c8f256d7a43f Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Sun, 27 May 2018 12:34:58 -0600
Subject: [PATCH] Document the allow_remote query param on the media repo

Fixes https://github.com/matrix-org/matrix-doc/issues/837

Signed-off-by: Travis Ralston <travpc@gmail.com>
---
 api/client-server/content-repo.yaml | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/api/client-server/content-repo.yaml b/api/client-server/content-repo.yaml
index 03a25fd97..f76b2fb95 100644
--- a/api/client-server/content-repo.yaml
+++ b/api/client-server/content-repo.yaml
@@ -95,6 +95,15 @@ paths:
           required: true
           description: |
             The media ID from the ``mxc://`` URI (the path component)
+        - in: query
+          type: boolean
+          name: allow_remote
+          x-example: false
+          required: false
+          description: |
+            Indicates to the server that it should not attempt to fetch the media if it is deemed
+            remote. This is to prevent routing loops where the server contacts itself. Defaults to 
+            true if not provided.
       responses:
         200:
           description: "The content that was previously uploaded."
@@ -140,6 +149,15 @@ paths:
           required: true
           description: |
             The filename to give in the Content-Disposition
+        - in: query
+          type: boolean
+          name: allow_remote
+          x-example: false
+          required: false
+          description: |
+            Indicates to the server that it should not attempt to fetch the media if it is deemed
+            remote. This is to prevent routing loops where the server contacts itself. Defaults to 
+            true if not provided.
       responses:
         200:
           description: "The content that was previously uploaded."
@@ -198,6 +216,15 @@ paths:
           name: method
           x-example: "scale"
           description: The desired resizing method.
+        - in: query
+          type: boolean
+          name: allow_remote
+          x-example: false
+          required: false
+          description: |
+            Indicates to the server that it should not attempt to fetch the media if it is deemed
+            remote. This is to prevent routing loops where the server contacts itself. Defaults to 
+            true if not provided.
       responses:
         200:
           description: "A thumbnail of the requested content."