From patchwork Tue Mar 29 18:57:31 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 1610795 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: bilbo.ozlabs.org; dkim=fail reason="key not found in DNS" header.d=that.guru header.i=@that.guru header.a=rsa-sha256 header.s=x header.b=OpD43ibF; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.ozlabs.org (client-ip=2404:9400:2:0:216:3eff:fee1:b9f1; helo=lists.ozlabs.org; envelope-from=patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org; receiver=) Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2404:9400:2:0:216:3eff:fee1:b9f1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by bilbo.ozlabs.org (Postfix) with ESMTPS id 4KSf2n1MZBz9sCq for ; Wed, 30 Mar 2022 05:57:52 +1100 (AEDT) Received: from boromir.ozlabs.org (localhost [IPv6:::1]) by lists.ozlabs.org (Postfix) with ESMTP id 4KSf2m36rDz2yJ9 for ; Wed, 30 Mar 2022 05:57:52 +1100 (AEDT) Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" header.d=that.guru header.i=@that.guru header.a=rsa-sha256 header.s=x header.b=OpD43ibF; dkim-atps=neutral X-Original-To: patchwork@lists.ozlabs.org Delivered-To: patchwork@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=none (no SPF record) smtp.mailfrom=that.guru (client-ip=136.175.108.186; helo=mail-108-mta186.mxroute.com; envelope-from=stephen@that.guru; receiver=) Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" header.d=that.guru header.i=@that.guru header.a=rsa-sha256 header.s=x header.b=OpD43ibF; dkim-atps=neutral Received: from mail-108-mta186.mxroute.com (mail-108-mta186.mxroute.com [136.175.108.186]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 4KSf2d3Pt4z2x9c for ; Wed, 30 Mar 2022 05:57:44 +1100 (AEDT) Received: from filter006.mxroute.com ([140.82.40.27] 140.82.40.27.vultrusercontent.com) (Authenticated sender: mN4UYu2MZsgR) by mail-108-mta186.mxroute.com (ZoneMTA) with ESMTPSA id 17fd70a6d7f000fe85.001 for (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256); Tue, 29 Mar 2022 18:57:39 +0000 X-Zone-Loop: 7e35291e6ca7c81aa8702866b077ae56829073c4b6a4 X-Originating-IP: [140.82.40.27] DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=x; h=Content-Transfer-Encoding:MIME-Version:Message-Id:Date:Subject:Cc:To: From:Sender:Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To: References:List-Id:List-Help:List-Unsubscribe:List-Subscribe:List-Post: List-Owner:List-Archive; bh=DqwUnuueRNjsx3kbiJI/TOiBlTERswsEEh6pMejVv1o=; b=O pD43ibFFYeUReGvs6jEqKIbAoxyHuz8Dor7H17GANl2+ncLGmUvU/wyloLa9a/+kkNhfVkJwWyfHZ UbWz2TM5JSfdVZyusO2UaRK0iP53jbgcpQbRo7te7umxQ3ExhNwNWZjLaZH8ircMWv5ntB6G4umFx gV93TwsASSU9asTmz0bUDQxv7zXdl1BwVgeL/ydjUG6niBINcTtq7qAdP1O/dqBP3M/BQTSjRTE2a EFk/xpTyjVuNEuFgFRrVaPj9Q58fXo0jzpyNlX5DWitueS/fMuEKHZ6NxQz0ivSgc6r2sba7Icu8t uDX4H8kyXQ2zJ5Pi+S/K7vvjKT0+CQpuA==; From: Stephen Finucane To: patchwork@lists.ozlabs.org Subject: [PATCH 1/2] docs: Don't version events Date: Tue, 29 Mar 2022 19:57:31 +0100 Message-Id: <20220329185732.401187-1-stephen@that.guru> X-Mailer: git-send-email 2.35.1 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Patchwork" We don't actually version the types of events we emit. Doing so would be possible, but this ship has already sailed (with API version 1.2). We also remove some unnecessary line breaks. Signed-off-by: Stephen Finucane --- docs/api/schemas/latest/patchwork.yaml | 21 +++++++------ docs/api/schemas/patchwork.j2 | 29 +++++++----------- docs/api/schemas/v1.0/patchwork.yaml | 41 ++++++++++++++++++++------ docs/api/schemas/v1.1/patchwork.yaml | 41 ++++++++++++++++++++------ docs/api/schemas/v1.2/patchwork.yaml | 21 +++++++------ docs/api/schemas/v1.3/patchwork.yaml | 21 +++++++------ 6 files changed, 104 insertions(+), 70 deletions(-) diff --git docs/api/schemas/latest/patchwork.yaml docs/api/schemas/latest/patchwork.yaml index 2a98c179..43edfb04 100644 --- docs/api/schemas/latest/patchwork.yaml +++ docs/api/schemas/latest/patchwork.yaml @@ -402,7 +402,11 @@ paths: type: string - in: query name: category - description: An event category to filter events by. + description: > + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. schema: title: '' type: string @@ -460,18 +464,13 @@ paths: mapping: cover-created: '#/components/schemas/EventCoverCreated' patch-created: '#/components/schemas/EventPatchCreated' - patch-completed: > - '#/components/schemas/EventPatchCompleted' - patch-state-changed: > - '#/components/schemas/EventPatchStateChanged' - patch-relation-changed: > - '#/components/schemas/EventPatchRelationChanged' - patch-delegated: > - '#/components/schemas/EventPatchDelegated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' check-created: '#/components/schemas/EventCheckCreated' series-created: '#/components/schemas/EventSeriesCreated' - series-completed: > - '#/components/schemas/EventSeriesCompleted' + series-completed: '#/components/schemas/EventSeriesCompleted' tags: - events /api/patches/: diff --git docs/api/schemas/patchwork.j2 docs/api/schemas/patchwork.j2 index 02aa9f72..df72c1ac 100644 --- docs/api/schemas/patchwork.j2 +++ docs/api/schemas/patchwork.j2 @@ -413,7 +413,11 @@ paths: type: string - in: query name: category - description: An event category to filter events by. + description: > + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. schema: title: '' type: string @@ -422,9 +426,7 @@ paths: - patch-created - patch-completed - patch-state-changed -{% if version >= (1, 2) %} - patch-relation-changed -{% endif %} - patch-delegated - check-created - series-created @@ -463,9 +465,7 @@ paths: - $ref: '#/components/schemas/EventPatchCreated' - $ref: '#/components/schemas/EventPatchCompleted' - $ref: '#/components/schemas/EventPatchStateChanged' -{% if version >= (1, 2) %} - $ref: '#/components/schemas/EventPatchRelationChanged' -{% endif %} - $ref: '#/components/schemas/EventPatchDelegated' - $ref: '#/components/schemas/EventCheckCreated' - $ref: '#/components/schemas/EventSeriesCreated' @@ -475,20 +475,13 @@ paths: mapping: cover-created: '#/components/schemas/EventCoverCreated' patch-created: '#/components/schemas/EventPatchCreated' - patch-completed: > - '#/components/schemas/EventPatchCompleted' - patch-state-changed: > - '#/components/schemas/EventPatchStateChanged' -{% if version >= (1, 2) %} - patch-relation-changed: > - '#/components/schemas/EventPatchRelationChanged' -{% endif %} - patch-delegated: > - '#/components/schemas/EventPatchDelegated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' check-created: '#/components/schemas/EventCheckCreated' series-created: '#/components/schemas/EventSeriesCreated' - series-completed: > - '#/components/schemas/EventSeriesCompleted' + series-completed: '#/components/schemas/EventSeriesCompleted' tags: - events /api/{{ version_url }}patches/: @@ -1922,7 +1915,6 @@ components: current_state: title: Current state type: string -{% if version >= (1, 2) %} EventPatchRelationChanged: allOf: - $ref: '#/components/schemas/EventBase' @@ -1943,7 +1935,6 @@ components: title: Current relation type: string nullable: true -{% endif %} EventPatchDelegated: allOf: - $ref: '#/components/schemas/EventBase' diff --git docs/api/schemas/v1.0/patchwork.yaml docs/api/schemas/v1.0/patchwork.yaml index 23e8930a..e2f1362f 100644 --- docs/api/schemas/v1.0/patchwork.yaml +++ docs/api/schemas/v1.0/patchwork.yaml @@ -228,7 +228,11 @@ paths: type: string - in: query name: category - description: An event category to filter events by. + description: > + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. schema: title: '' type: string @@ -237,6 +241,7 @@ paths: - patch-created - patch-completed - patch-state-changed + - patch-relation-changed - patch-delegated - check-created - series-created @@ -275,6 +280,7 @@ paths: - $ref: '#/components/schemas/EventPatchCreated' - $ref: '#/components/schemas/EventPatchCompleted' - $ref: '#/components/schemas/EventPatchStateChanged' + - $ref: '#/components/schemas/EventPatchRelationChanged' - $ref: '#/components/schemas/EventPatchDelegated' - $ref: '#/components/schemas/EventCheckCreated' - $ref: '#/components/schemas/EventSeriesCreated' @@ -284,16 +290,13 @@ paths: mapping: cover-created: '#/components/schemas/EventCoverCreated' patch-created: '#/components/schemas/EventPatchCreated' - patch-completed: > - '#/components/schemas/EventPatchCompleted' - patch-state-changed: > - '#/components/schemas/EventPatchStateChanged' - patch-delegated: > - '#/components/schemas/EventPatchDelegated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' check-created: '#/components/schemas/EventCheckCreated' series-created: '#/components/schemas/EventSeriesCreated' - series-completed: > - '#/components/schemas/EventSeriesCompleted' + series-completed: '#/components/schemas/EventSeriesCompleted' tags: - events /api/1.0/patches/: @@ -1485,6 +1488,26 @@ components: current_state: title: Current state type: string + EventPatchRelationChanged: + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-relation-changed + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + previous_relation: + title: Previous relation + type: string + nullable: true + current_relation: + title: Current relation + type: string + nullable: true EventPatchDelegated: allOf: - $ref: '#/components/schemas/EventBase' diff --git docs/api/schemas/v1.1/patchwork.yaml docs/api/schemas/v1.1/patchwork.yaml index 3b75c548..cdf8ef29 100644 --- docs/api/schemas/v1.1/patchwork.yaml +++ docs/api/schemas/v1.1/patchwork.yaml @@ -228,7 +228,11 @@ paths: type: string - in: query name: category - description: An event category to filter events by. + description: > + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. schema: title: '' type: string @@ -237,6 +241,7 @@ paths: - patch-created - patch-completed - patch-state-changed + - patch-relation-changed - patch-delegated - check-created - series-created @@ -275,6 +280,7 @@ paths: - $ref: '#/components/schemas/EventPatchCreated' - $ref: '#/components/schemas/EventPatchCompleted' - $ref: '#/components/schemas/EventPatchStateChanged' + - $ref: '#/components/schemas/EventPatchRelationChanged' - $ref: '#/components/schemas/EventPatchDelegated' - $ref: '#/components/schemas/EventCheckCreated' - $ref: '#/components/schemas/EventSeriesCreated' @@ -284,16 +290,13 @@ paths: mapping: cover-created: '#/components/schemas/EventCoverCreated' patch-created: '#/components/schemas/EventPatchCreated' - patch-completed: > - '#/components/schemas/EventPatchCompleted' - patch-state-changed: > - '#/components/schemas/EventPatchStateChanged' - patch-delegated: > - '#/components/schemas/EventPatchDelegated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' check-created: '#/components/schemas/EventCheckCreated' series-created: '#/components/schemas/EventSeriesCreated' - series-completed: > - '#/components/schemas/EventSeriesCompleted' + series-completed: '#/components/schemas/EventSeriesCompleted' tags: - events /api/1.1/patches/: @@ -1510,6 +1513,26 @@ components: current_state: title: Current state type: string + EventPatchRelationChanged: + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-relation-changed + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + previous_relation: + title: Previous relation + type: string + nullable: true + current_relation: + title: Current relation + type: string + nullable: true EventPatchDelegated: allOf: - $ref: '#/components/schemas/EventBase' diff --git docs/api/schemas/v1.2/patchwork.yaml docs/api/schemas/v1.2/patchwork.yaml index 17d948a2..2a37d81b 100644 --- docs/api/schemas/v1.2/patchwork.yaml +++ docs/api/schemas/v1.2/patchwork.yaml @@ -336,7 +336,11 @@ paths: type: string - in: query name: category - description: An event category to filter events by. + description: > + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. schema: title: '' type: string @@ -394,18 +398,13 @@ paths: mapping: cover-created: '#/components/schemas/EventCoverCreated' patch-created: '#/components/schemas/EventPatchCreated' - patch-completed: > - '#/components/schemas/EventPatchCompleted' - patch-state-changed: > - '#/components/schemas/EventPatchStateChanged' - patch-relation-changed: > - '#/components/schemas/EventPatchRelationChanged' - patch-delegated: > - '#/components/schemas/EventPatchDelegated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' check-created: '#/components/schemas/EventCheckCreated' series-created: '#/components/schemas/EventSeriesCreated' - series-completed: > - '#/components/schemas/EventSeriesCompleted' + series-completed: '#/components/schemas/EventSeriesCompleted' tags: - events /api/1.2/patches/: diff --git docs/api/schemas/v1.3/patchwork.yaml docs/api/schemas/v1.3/patchwork.yaml index 0a9046a5..88c4e355 100644 --- docs/api/schemas/v1.3/patchwork.yaml +++ docs/api/schemas/v1.3/patchwork.yaml @@ -402,7 +402,11 @@ paths: type: string - in: query name: category - description: An event category to filter events by. + description: > + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. schema: title: '' type: string @@ -460,18 +464,13 @@ paths: mapping: cover-created: '#/components/schemas/EventCoverCreated' patch-created: '#/components/schemas/EventPatchCreated' - patch-completed: > - '#/components/schemas/EventPatchCompleted' - patch-state-changed: > - '#/components/schemas/EventPatchStateChanged' - patch-relation-changed: > - '#/components/schemas/EventPatchRelationChanged' - patch-delegated: > - '#/components/schemas/EventPatchDelegated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' check-created: '#/components/schemas/EventCheckCreated' series-created: '#/components/schemas/EventSeriesCreated' - series-completed: > - '#/components/schemas/EventSeriesCompleted' + series-completed: '#/components/schemas/EventSeriesCompleted' tags: - events /api/1.3/patches/: