Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/1523323/?format=api
{ "id": 1523323, "url": "http://patchwork.ozlabs.org/api/patches/1523323/?format=api", "web_url": "http://patchwork.ozlabs.org/project/patchwork/patch/20210901165756.181192-5-stephen@that.guru/", "project": { "id": 16, "url": "http://patchwork.ozlabs.org/api/projects/16/?format=api", "name": "Patchwork", "link_name": "patchwork", "list_id": "patchwork.lists.ozlabs.org", "list_email": "patchwork@lists.ozlabs.org", "web_url": "http://jk.ozlabs.org/projects/patchwork/", "scm_url": "git://github.com/getpatchwork/patchwork", "webscm_url": "https://github.com/getpatchwork/patchwork", "list_archive_url": "", "list_archive_url_format": "", "commit_url_format": "" }, "msgid": "<20210901165756.181192-5-stephen@that.guru>", "list_archive_url": null, "date": "2021-09-01T16:57:41", "name": "[RFC,v2,04/19] REST: Include 'first', 'last' refs in 'Link' header", "commit_ref": null, "pull_url": null, "state": "rfc", "archived": false, "hash": "a0e1c10229e3d3ec9dcecc0c1fc7c5e967c87bf2", "submitter": { "id": 69991, "url": "http://patchwork.ozlabs.org/api/people/69991/?format=api", "name": "Stephen Finucane", "email": "stephen@that.guru" }, "delegate": null, "mbox": "http://patchwork.ozlabs.org/project/patchwork/patch/20210901165756.181192-5-stephen@that.guru/mbox/", "series": [ { "id": 260605, "url": "http://patchwork.ozlabs.org/api/series/260605/?format=api", "web_url": "http://patchwork.ozlabs.org/project/patchwork/list/?series=260605", "date": "2021-09-01T16:57:37", "name": "Integrate Bulma", "version": 2, "mbox": "http://patchwork.ozlabs.org/series/260605/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/1523323/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/1523323/checks/", "tags": {}, "related": [ { "id": 1516034, "url": "http://patchwork.ozlabs.org/api/patches/1516034/?format=api", "web_url": "http://patchwork.ozlabs.org/project/patchwork/patch/20210811213705.36293-5-stephen@that.guru/", "msgid": "<20210811213705.36293-5-stephen@that.guru>", "list_archive_url": null, "date": "2021-08-11T21:36:50", "name": "[RFC,04/19] REST: Include 'first', 'last' refs in 'Link' header", "mbox": "http://patchwork.ozlabs.org/project/patchwork/patch/20210811213705.36293-5-stephen@that.guru/mbox/" } ], "headers": { "Return-Path": "\n <patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org>", "X-Original-To": [ "incoming@patchwork.ozlabs.org", "patchwork@lists.ozlabs.org" ], "Delivered-To": [ "patchwork-incoming@bilbo.ozlabs.org", "patchwork@lists.ozlabs.org" ], "Authentication-Results": [ "ozlabs.org;\n\tdkim=fail reason=\"key not found in DNS\" header.d=that.guru\n header.i=@that.guru header.a=rsa-sha256 header.s=x header.b=QsjlWjVm;\n\tdkim-atps=neutral", "ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=lists.ozlabs.org\n (client-ip=2404:9400:2:0:216:3eff:fee1:b9f1; helo=lists.ozlabs.org;\n envelope-from=patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org;\n receiver=<UNKNOWN>)", "lists.ozlabs.org;\n\tdkim=fail reason=\"key not found in DNS\" header.d=that.guru\n header.i=@that.guru header.a=rsa-sha256 header.s=x header.b=QsjlWjVm;\n\tdkim-atps=neutral", "lists.ozlabs.org;\n spf=none (no SPF record) smtp.mailfrom=that.guru\n (client-ip=136.175.108.127; helo=mail-108-mta127.mxroute.com;\n envelope-from=stephen@that.guru; receiver=<UNKNOWN>)", "lists.ozlabs.org;\n dkim=fail reason=\"key not found in DNS\" header.d=that.guru\n header.i=@that.guru\n header.a=rsa-sha256 header.s=x header.b=QsjlWjVm;\n dkim-atps=neutral" ], "Received": [ "from lists.ozlabs.org (lists.ozlabs.org\n [IPv6:2404:9400:2:0:216:3eff:fee1:b9f1])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\t key-exchange X25519 server-signature RSA-PSS (4096 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 4H09HS2YBJz9sW8\n\tfor <incoming@patchwork.ozlabs.org>; Thu, 2 Sep 2021 02:58:28 +1000 (AEST)", "from boromir.ozlabs.org (localhost [IPv6:::1])\n\tby lists.ozlabs.org (Postfix) with ESMTP id 4H09HS1MZgz2yJG\n\tfor <incoming@patchwork.ozlabs.org>; Thu, 2 Sep 2021 02:58:28 +1000 (AEST)", "from mail-108-mta127.mxroute.com (mail-108-mta127.mxroute.com\n [136.175.108.127])\n (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))\n (No client certificate requested)\n by lists.ozlabs.org (Postfix) with ESMTPS id 4H09H96vlnz2xt3\n for <patchwork@lists.ozlabs.org>; Thu, 2 Sep 2021 02:58:13 +1000 (AEST)", "from filter004.mxroute.com ([149.28.56.236] filter004.mxroute.com)\n (Authenticated sender: mN4UYu2MZsgR)\n by mail-108-mta127.mxroute.com (ZoneMTA) with ESMTPSA id\n 17ba24beadb00074ba.001 for <patchwork@lists.ozlabs.org>\n (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256);\n Wed, 01 Sep 2021 16:58:09 +0000" ], "X-Zone-Loop": "108f14f4c50842b3ca0eaac4f90141c24f2c0e845e18", "X-Originating-IP": "[149.28.56.236]", "DKIM-Signature": "v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru;\n s=x;\n h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To:\n Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID:\n Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc\n :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe:\n List-Post:List-Owner:List-Archive;\n bh=XzNNE+41gh/IYBj6q+G7fH3LpgUkWTsj+uSDkUPOwSw=; b=QsjlWjVmDPlXEXL6JfV6CFhuNh\n a8uRp+2FJfO13MtiMKrkA1Hwx8Lj6hqxT6ifegpLzAOqIMuQzhWayiLQl5zRSM7BlN1kDK8/oWqz1\n OQIas0AQ4lgLU8XCyGM1cNl6yvG8JyIA5LAP9mvZ4FpFbumaOv664RimD+qGjYaKgGsMgT6yK55Wt\n 4NKaeR3phFNPdoxveuzvFIxKqmT9B2agU1JbKtWOXK8oRHTq1cV0lC87u5L2fXpuvpWtak3xisSXH\n vvNOmAkq1dSXaOXR5lrJ0eUeb+aK9UafvPcIM0JhYlkEla5Pjc8XD/clxVmty5/C9/sPSdKIFgH9a\n wkLWoedQ==;", "From": "Stephen Finucane <stephen@that.guru>", "To": "patchwork@lists.ozlabs.org", "Subject": "[RFC PATCH v2 04/19] REST: Include 'first',\n 'last' refs in 'Link' header", "Date": "Wed, 1 Sep 2021 17:57:41 +0100", "Message-Id": "<20210901165756.181192-5-stephen@that.guru>", "X-Mailer": "git-send-email 2.31.1", "In-Reply-To": "<20210901165756.181192-1-stephen@that.guru>", "References": "<20210901165756.181192-1-stephen@that.guru>", "MIME-Version": "1.0", "X-AuthUser": "stephen@that.guru", "X-BeenThere": "patchwork@lists.ozlabs.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "Patchwork development <patchwork.lists.ozlabs.org>", "List-Unsubscribe": "<https://lists.ozlabs.org/options/patchwork>,\n <mailto:patchwork-request@lists.ozlabs.org?subject=unsubscribe>", "List-Archive": "<http://lists.ozlabs.org/pipermail/patchwork/>", "List-Post": "<mailto:patchwork@lists.ozlabs.org>", "List-Help": "<mailto:patchwork-request@lists.ozlabs.org?subject=help>", "List-Subscribe": "<https://lists.ozlabs.org/listinfo/patchwork>,\n <mailto:patchwork-request@lists.ozlabs.org?subject=subscribe>", "Content-Type": "text/plain; charset=\"us-ascii\"", "Content-Transfer-Encoding": "7bit", "Errors-To": "patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org", "Sender": "\"Patchwork\"\n <patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org>" }, "content": "I've no idea why this wasn't done from day one, but it's a huge\nusability win for anyone attempting to do pagination with this header.\n\nSigned-off-by: Stephen Finucane <stephen@that.guru>\n---\n patchwork/api/base.py | 33 ++++++++++++++++++++++++---------\n 1 file changed, 24 insertions(+), 9 deletions(-)", "diff": "diff --git patchwork/api/base.py patchwork/api/base.py\nindex d870a511..7baac275 100644\n--- patchwork/api/base.py\n+++ patchwork/api/base.py\n@@ -12,6 +12,7 @@ from rest_framework.pagination import PageNumberPagination\n from rest_framework.response import Response\n from rest_framework.serializers import HyperlinkedIdentityField\n from rest_framework.serializers import HyperlinkedModelSerializer\n+from rest_framework.utils.urls import replace_query_param\n \n from patchwork.api import utils\n \n@@ -59,19 +60,33 @@ class LinkHeaderPagination(PageNumberPagination):\n max_page_size = settings.MAX_REST_RESULTS_PER_PAGE\n page_size_query_param = 'per_page'\n \n+ def get_first_link(self):\n+ url = self.request.build_absolute_uri()\n+ return replace_query_param(url, self.page_query_param, 1)\n+\n+ def get_last_link(self):\n+ url = self.request.build_absolute_uri()\n+ page_number = self.page.paginator.num_pages\n+ return replace_query_param(url, self.page_query_param, page_number)\n+\n def get_paginated_response(self, data):\n next_url = self.get_next_link()\n previous_url = self.get_previous_link()\n+ first_url = self.get_first_link()\n+ last_url = self.get_last_link()\n+\n+ links = []\n+\n+ if next_url is not None:\n+ links.append(f'<{next_url}>; rel=\"next\"')\n+\n+ if previous_url is not None:\n+ links.append(f'<{previous_url}>; rel=\"prev\"')\n+\n+ links.append(f'<{first_url}>; rel=\"first\"')\n+ links.append(f'<{last_url}>; rel=\"last\"')\n \n- link = ''\n- if next_url is not None and previous_url is not None:\n- link = '<{next_url}>; rel=\"next\", <{previous_url}>; rel=\"prev\"'\n- elif next_url is not None:\n- link = '<{next_url}>; rel=\"next\"'\n- elif previous_url is not None:\n- link = '<{previous_url}>; rel=\"prev\"'\n- link = link.format(next_url=next_url, previous_url=previous_url)\n- headers = {'Link': link} if link else {}\n+ headers = {'Link': ', '.join(links)} if links else {}\n return Response(data, headers=headers)\n \n \n", "prefixes": [ "RFC", "v2", "04/19" ] }