summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <paul@matrix.org>2014-08-13 15:07:49 +0100
committerPaul "LeoNerd" Evans <paul@matrix.org>2014-08-13 15:07:55 +0100
commit820ed34abefafd43e9853d147606a8231d4d909f (patch)
tree74ac8521485e53bf418f9ec838bddec346b40cea /docs
parentAdd troubleshooting section to help with PyNaCl bug. (diff)
downloadsynapse-820ed34abefafd43e9853d147606a8231d4d909f.tar.xz
Namespace all the Federation HTTP URLs to /matrix/federation/v1/...
Diffstat (limited to 'docs')
-rw-r--r--docs/server-server/specification.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/server-server/specification.rst b/docs/server-server/specification.rst
index e1e49cc069..a386bd3e7d 100644
--- a/docs/server-server/specification.rst
+++ b/docs/server-server/specification.rst
@@ -116,9 +116,13 @@ federation.]]
 Protocol URLs
 =============
 
+All these URLs are namespaced within a prefix of 
+
+  /matrix/federation/v1/...
+
 For active pushing of messages representing live activity "as it happens":
 
-  PUT /send/:transaction_id/
+  PUT .../send/:transaction_id/
     Body: JSON encoding of a single Transaction
 
     Response: [[TODO(paul): I don't actually understand what
@@ -132,7 +136,7 @@ For active pushing of messages representing live activity "as it happens":
 
 To fetch a particular PDU:
 
-  GET /pdu/:origin/:pdu_id/
+  GET .../pdu/:origin/:pdu_id/
 
     Response: JSON encoding of a single Transaction containing one PDU
 
@@ -142,7 +146,7 @@ To fetch a particular PDU:
 
 To fetch all the state of a given context:
 
-  GET /state/:context/
+  GET .../state/:context/
 
     Response: JSON encoding of a single Transaction containing multiple PDUs
 
@@ -153,7 +157,7 @@ To fetch all the state of a given context:
 
 To paginate events on a given context:
 
-  GET /paginate/:context/
+  GET .../paginate/:context/
     Query args: v, limit
 
     Response: JSON encoding of a single Transaction containing multiple PDUs
@@ -167,7 +171,7 @@ To paginate events on a given context:
 
 To stream events all the events:
 
-  GET /pull/
+  GET .../pull/
     Query args: origin, v
 
   Response: JSON encoding of a single Transaction consisting of multiple PDUs