Commit Graph

10 Commits

Author SHA1 Message Date
Lauryn Menard
214008e92d api-docs: Move zuliprc file documentation to API keys article.
As zuliprc files are in a standard format that you can access from
any programming language, not just Python, it makes more sense to
have them documented with the information about API keys.

Fixes #10670.
2026-04-05 15:00:57 -07:00
Lauryn Menard
47a4d8900d api-docs: Update placeholder for curl user basic auth credentials.
Updates the placeholder in the curl examples of the API docs for
the user authentication line (-u) to be EMAIL_ADDRESS:API_KEY.

Adds text to the top of the curl tab about the user authentication
line with links to the curl man doc and the authorization header
section of the HTTP headers article.

If the endpoint does not have the user auth line (e.g., fetching
an API key in dev and production), then the text is not added to
the curl tab.

Fixes #479.
2026-02-26 10:18:12 -08:00
Lauryn Menard
e79152ac56 api-docs: Expand the section on the HTTP Basic auth header.
Expands the section on the `Authorization` header to include
the basic structure of the `Basic` auth credentials in the Zulip
API and information for how to get those credentials for bots
and users.

Cleans up some formatting, revises the tip at the top of the page
and adds a link to the `man curl` doc online.
2026-02-23 09:02:37 -08:00
Lauryn Menard
99bbc26e4b api-docs: Add authorization header section to http-headers article. 2026-02-17 09:32:27 -08:00
Alex Vandiver
f1cf443a9a Revert "rate_limit: Additionally limit to 2000 authenticated requests per hour."
This reverts commit 5c2b0d91d5.  2000
requests per minute is quite possible for legitimate users to hit if
they have multiple tabs or clients open to the server.
2026-01-20 14:20:48 -05:00
Alex Vandiver
5c2b0d91d5 rate_limit: Additionally limit to 2000 authenticated requests per hour. 2025-10-27 16:22:13 -07:00
Lauryn Menard
e4b425c083 docs: Update links for renamed securing-your-zulip-server doc. 2025-10-13 10:06:31 -07:00
Niloth P
344c1ef606 docs: Use bold formatting for channel names instead of backticks.
Update the occurrences of channel names that still use backticks to use
the convention of bold formatting.
2025-07-03 10:51:13 -07:00
Alex Vandiver
eefe147c34 web: Fix links which were missing trailing slashes. 2024-01-11 13:52:12 -08:00
Lauryn Menard
dfb9f74017 api_docs: Add page documenting HTTP headers in the api docs.
Adds a page to the general api documentation about HTTP headers,
so that information about the special response headers for rate
limits have a more logical location in the docs and so that other
HTTP header information can be shared, such as `User-Agent`
conventions.

Adjusts some text and linking on the rest-error-handling page and
overview page for the REST API for the addition of the HTTP headers
page.
2023-03-07 12:51:17 -08:00