Add HTTP 429 Too Many Requests as a possible generic error response

Author: js-nh

example/tests/__snapshots__/test_openapi.ambr

@@ -68,7 +68,17 @@
           }
         },
         "description": "[Resource does not exist](https://jsonapi.org/format/#crud-deleting-responses-404)"
-      }
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
+      },
     },
     "tags": [
       "authors"
@@ -264,7 +274,17 @@
           }
         },
         "description": "[Conflict]([Conflict](https://jsonapi.org/format/#crud-updating-responses-409)"
-      }
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
+      },
     },
     "tags": [
       "authors"
@@ -399,7 +419,17 @@
           }
         },
         "description": "not found"
-      }
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
+      },
     },
     "tags": [
       "authors"
@@ -546,7 +576,17 @@
           }
         },
         "description": "not found"
-      }
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
+      },
     },
     "tags": [
       "authors"
@@ -754,7 +794,17 @@
           }
         },
         "description": "[Conflict](https://jsonapi.org/format/#crud-creating-responses-409)"
-      }
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
+      },
     },
     "tags": [
       "authors"
@@ -1341,7 +1391,17 @@
                 }
               },
               "description": "not found"
-            }
+            },
+            "429": {
+              "content": {
+                "application/vnd.api+json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/failure"
+                  }
+                }
+              },
+              "description": "too many requests"
+            },
           },
           "tags": [
             "authors"

rest_framework_json_api/schemas/openapi.py

@@ -807,6 +807,7 @@ def _add_generic_failure_responses(self, operation):
         for code, reason in [
             ("400", "bad request"),
             ("401", "not authorized"),
+            ("429", "too many requests"),
         ]:
             operation["responses"][code] = self._failure_response(reason)