From a9141f2277e697479782e9e5c142e7c340585c4d Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 18 Jun 2024 13:53:58 +0200 Subject: [PATCH] api-docs: Update API feature level 36 rate limit error changes notes. --- api_docs/changelog.md | 5 +++-- zerver/openapi/zulip.yaml | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/api_docs/changelog.md b/api_docs/changelog.md index cd05768211..c9def3ca36 100644 --- a/api_docs/changelog.md +++ b/api_docs/changelog.md @@ -1975,8 +1975,9 @@ field with an integer field `invite_to_realm_policy`. * [`POST /users`](/api/create-user): Restricted access to organization administrators with the `can_create_users` permission. -* [Error handling](/api/rest-error-handling): The `code` property will - now be present in errors due to rate limits. +* [Error handling](/api/rest-error-handling#common-error-responses): The + `code` key will now be present in errors that are due to rate + limits, with a value of `"RATE_LIMIT_HIT"`. **Feature level 35** diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index f824b813f3..8f2860365b 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -22243,8 +22243,8 @@ components: The value of `retry-after` in the response indicates how many seconds the client must wait before making additional requests. - **Changes**: The `code` field was not present in rate - limit errors before Zulip 4.0 (feature level 36). + **Changes**: Before Zulip 4.0 (feature level 36), the `code` key + was not present in rate limit errors. [rate-limit-headers]: /api/http-headers#rate-limiting-response-headers properties: