From 99dfe64d5cf0dc5e8eed4631a25d31669de659d1 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Fri, 29 May 2015 15:48:48 +0100
Subject: [PATCH] Add rate-limiting on APIs which rate limit. More
 descriptions.

---
 api/client-server/v1/definitions/error.yaml | 3 +++
 api/client-server/v1/profile.yaml           | 8 ++++++++
 2 files changed, 11 insertions(+)

diff --git a/api/client-server/v1/definitions/error.yaml b/api/client-server/v1/definitions/error.yaml
index 5a5587ab..20312ae4 100644
--- a/api/client-server/v1/definitions/error.yaml
+++ b/api/client-server/v1/definitions/error.yaml
@@ -1,7 +1,10 @@
 type: object
+description: A Matrix-level Error
 properties:
   errcode:
     type: string
+    description: An error code.
   error:
     type: string
+    description: A human-readable error message.
 required: ["errcode"]
\ No newline at end of file
diff --git a/api/client-server/v1/profile.yaml b/api/client-server/v1/profile.yaml
index d0343a2c..99507186 100644
--- a/api/client-server/v1/profile.yaml
+++ b/api/client-server/v1/profile.yaml
@@ -44,6 +44,10 @@ paths:
           description: The display name was set.
           schema:
             type: object  # empty json object
+        429:
+          description: This request was rate-limited.
+          schema:
+            "$ref": "definitions/error.yaml"
     get:
       summary: Get the user's display name.
       parameters:
@@ -89,6 +93,10 @@ paths:
           description: The avatar URL was set.
           schema:
             type: object  # empty json object
+        429:
+          description: This request was rate-limited.
+          schema:
+            "$ref": "definitions/error.yaml"
     get:
       summary: Get the user's avatar URL.
       parameters: