From patchwork Tue Oct 30 11:19:11 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 990736 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 42kpyh5Zdzz9s7W for ; Tue, 30 Oct 2018 22:24:28 +1100 (AEDT) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="RSHUJqAx"; dkim-atps=neutral Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 42kpyh37SDzF10S for ; Tue, 30 Oct 2018 22:24:28 +1100 (AEDT) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="RSHUJqAx"; dkim-atps=neutral X-Original-To: patchwork@lists.ozlabs.org Delivered-To: patchwork@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=none (mailfrom) smtp.mailfrom=that.guru (client-ip=185.234.75.13; helo=relay013.mxrelay.co; envelope-from=stephen@that.guru; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="RSHUJqAx"; dkim-atps=neutral Received: from relay013.mxrelay.co (relay013.mxrelay.co [185.234.75.13]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 42kpsZ6TbMzDrPq for ; Tue, 30 Oct 2018 22:20:02 +1100 (AEDT) Received: from filter002.mxroute.com (unknown [185.133.192.179]) by relay013.mxrelay.co (Postfix) with ESMTP id 60EE642DEB for ; Tue, 30 Oct 2018 11:19:30 +0000 (UTC) Received: from one.mxroute.com (one.mxroute.com [195.201.59.211]) by filter002.mxroute.com (Postfix) with ESMTPS id 286F03F3DB for ; Tue, 30 Oct 2018 11:19:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=oK3p1hog7RBYJDTorz0ngDo+HNxDW/dMQCGy3DW73DM=; b=RSHUJqAx/8z7HuwrlTzktYUlyf T1Auhb6J/PRPASDwwU//2Lx5YPLrc2QiD22OVJYVvmWoo4EFMgpjciXQqzfQoODS5k1ua55ViXk+X xb/tU1XSs1IJujhCS0DZO5CA3+B47VCy7h8oYD6kgejeK28J5CsY8ftSYgWcIC2lSkg/e3bTgBQv9 hxwof3xbboNwBtkwEmjWaZjCj6RdWAJ+NmSUzBtL0usilF/fH2AcQ2Q+33+JYsA8mlLEOk1io9PSW FFXDWPrAGShw8qgXdDR5HPFmnwZxhNzgQkPgIkeX/M7fiyUixH5Cg8hdNtDIsJc+gH8rdRo4c9Hh0 E+debJRA==; From: Stephen Finucane To: patchwork@lists.ozlabs.org Subject: [PATCH 12/17] docs: Document the '/series' resource Date: Tue, 30 Oct 2018 11:19:11 +0000 Message-Id: <20181030111916.7342-13-stephen@that.guru> X-Mailer: git-send-email 2.17.2 In-Reply-To: <20181030111916.7342-1-stephen@that.guru> References: <20181030111916.7342-1-stephen@that.guru> 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: , MIME-Version: 1.0 Errors-To: patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Patchwork" Signed-off-by: Stephen Finucane --- docs/api/schemas/patchwork.yaml | 166 ++++++++++++++++++++++++++++++++ 1 file changed, 166 insertions(+) diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml index 0763bd50..be5834a3 100644 --- a/docs/api/schemas/patchwork.yaml +++ b/docs/api/schemas/patchwork.yaml @@ -531,6 +531,70 @@ paths: $ref: '#/components/schemas/Error' tags: - projects + /api/series/: + get: + description: List series. + operationId: series_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - $ref: '#/components/parameters/BeforeFilter' + - $ref: '#/components/parameters/SinceFilter' + - in: query + name: submitter + schema: + description: '' + title: '' + type: string + - in: query + name: project + schema: + description: '' + title: '' + type: string + responses: + '200': + description: '' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Series' + tags: + - series + /api/series/{id}/: + get: + description: Show a series. + operationId: series_read + parameters: + - in: path + name: id + required: true + schema: + description: '' + title: '' + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/Series' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - series /api/users/: get: description: List users. @@ -1125,6 +1189,71 @@ components: type: string readOnly: true minLength: 1 + Series: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + web_url: + title: Web url + type: string + format: uri + readOnly: true + project: + $ref: '#/components/schemas/ProjectEmbedded' + name: + title: Name + description: An optional name to associate with the series, e.g. "John's PCI + series". + type: string + maxLength: 255 + x-nullable: true + date: + title: Date + type: string + format: date-time + readOnly: true + submitter: + title: Submitter + type: integer + readOnly: true + version: + title: Version + description: Version of series as indicated by the subject prefix(es) + type: integer + total: + title: Total + description: Number of patches in series as indicated by the subject prefix(es) + type: integer + readOnly: true + received_total: + title: Received total + type: integer + readOnly: true + received_all: + title: Received all + type: boolean + readOnly: true + mbox: + title: Mbox + type: string + format: uri + readOnly: true + cover_letter: + $ref: '#/components/schemas/CoverLetterEmbedded' + patches: + type: array + items: + $ref: '#/components/schemas/PatchEmbedded' + readOnly: true + uniqueItems: true User: type: object properties: @@ -1157,6 +1286,43 @@ components: format: email readOnly: true minLength: 1 + CoverLetterEmbedded: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + web_url: + title: Web url + type: string + format: uri + readOnly: true + msgid: + title: Msgid + type: string + readOnly: true + minLength: 1 + date: + title: Date + type: string + format: date-time + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + mbox: + title: Mbox + type: string + format: uri + readOnly: true PatchEmbedded: type: object properties: