Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Document how to restrict/throttle API access

Open
#325 5 comments 0 reactions 1 assignee View on GitHub

@ajdlinux is already working on this.

Since Nov 27, 2019.

Assessment

This issue has not been assessed yet.

Description

api documentation enhancement

Requested by Konstantin: https://lists.ozlabs.org/pipermail/patchwork/2019-November/006369.html

Site admins may want to restrict API access to authenticated users only to control server load.


edit: Looks like with some settings in REST_FRAMEWORK, restricting to authenticated users is probably doable by setting the right default permission classes, and there's settings for throttling too. We should add a mention of this to the documentation for the sake of admins who are unfamiliar

Dominant language
Python
Stars
317
Forks
91
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getpatchwork/patchwork

All issues in getpatchwork/patchwork

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.