summary refs log tree commit diff
path: root/docs/client-server/swagger_matrix/api-docs-directory
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-09-03 16:27:01 +0100
committerKegan Dougal <kegan@matrix.org>2014-09-03 16:27:01 +0100
commit581c54bebef865039352f4ec141c98413cb45f53 (patch)
tree4f249c2cbe11122152594a96eec1b2a59fb673d8 /docs/client-server/swagger_matrix/api-docs-directory
parentFix up directory server to not require uploading room hosts. Update the room ... (diff)
downloadsynapse-581c54bebef865039352f4ec141c98413cb45f53.tar.xz
Add exception handling to directory servlet, so we don't 500. Mark directory API as volatile in the api docs.
Diffstat (limited to 'docs/client-server/swagger_matrix/api-docs-directory')
-rw-r--r--docs/client-server/swagger_matrix/api-docs-directory2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/client-server/swagger_matrix/api-docs-directory b/docs/client-server/swagger_matrix/api-docs-directory
index 380ec3f477..ce12be8c96 100644
--- a/docs/client-server/swagger_matrix/api-docs-directory
+++ b/docs/client-server/swagger_matrix/api-docs-directory
@@ -13,6 +13,7 @@
         {
           "method": "GET",
           "summary": "Get the room ID corresponding to this room alias.",
+          "notes": "Volatile: This API is likely to change.",
           "type": "DirectoryResponse",
           "nickname": "get_room_id_for_alias",
           "parameters": [
@@ -28,6 +29,7 @@
         {
           "method": "PUT",
           "summary": "Create a new mapping from room alias to room ID.",
+          "notes": "Volatile: This API is likely to change.",
           "type": "void",
           "nickname": "add_room_alias",
           "parameters": [