From patchwork Tue Oct 30 11:19:09 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 990745 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 42kq2P1x86z9s7W for ; Tue, 30 Oct 2018 22:27:41 +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="bzR9ua/0"; 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 42kq2P015ZzDrNx for ; Tue, 30 Oct 2018 22:27:41 +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="bzR9ua/0"; 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.12; helo=relay012.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="bzR9ua/0"; dkim-atps=neutral Received: from relay012.mxrelay.co (relay012.mxrelay.co [185.234.75.12]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 42kpsg52qKzF100 for ; Tue, 30 Oct 2018 22:20:07 +1100 (AEDT) Received: from filter001.mxrelay.co (filter001.mxrelay.co [64.52.23.203]) by relay012.mxrelay.co (Postfix) with ESMTP id EF3A93F9FE for ; Tue, 30 Oct 2018 11:19:34 +0000 (UTC) Received: from one.mxroute.com (one.mxroute.com [195.201.59.211]) by filter001.mxrelay.co (Postfix) with ESMTPS id 4C3BE100065 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=yJNFR9M8d09anuEBP2qaB3xfCk78rNz95BbIPL4aVAA=; b=bzR9ua/0H4Iu2Elcj4Y7tiO6zO 6aT4klvEqykMCplsl1ogqlsewyzZ9A444S0HMtcQUYZAG7aj/OwbSBvir02feIp2RNePcwBDgbWrf 8wFNuDU6NdOfRKjlfKaQXs1xAewlsxdH5Whvz2G9JBtaeDExRNthHiifCBefjMU+t98hGP0sxa5OS CsZN0BleI9ZKYRC+dI1OXjj4oBVX1rypA880WGH9IForzDVf8lDYHLVT620fcZzGZstBWp3ZDCXCx 7bscF8BKb5gqxVejVcdkHDF3d3SVe/aA6wwOwbPfbBMf+2K7QZoLrZ7FjMGGUle5NgciKKZHU98WD GXR9TQMw==; From: Stephen Finucane To: patchwork@lists.ozlabs.org Subject: [PATCH 10/17] docs: Document the '/covers' resource Date: Tue, 30 Oct 2018 11:19:09 +0000 Message-Id: <20181030111916.7342-11-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" Again, we're adding embedded serializers before the main resource but that will come. Signed-off-by: Stephen Finucane --- docs/api/schemas/patchwork.yaml | 210 ++++++++++++++++++++++++++++++++ 1 file changed, 210 insertions(+) diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml index c5c29b50..3cadd35a 100644 --- a/docs/api/schemas/patchwork.yaml +++ b/docs/api/schemas/patchwork.yaml @@ -93,6 +93,76 @@ paths: $ref: '#/components/schemas/Error' tags: - bundles + /api/covers/: + get: + description: List cover letters. + operationId: covers_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: project + schema: + description: '' + title: '' + type: string + - in: query + name: series + schema: + description: '' + title: '' + type: string + - in: query + name: submitter + schema: + description: '' + title: '' + type: string + responses: + '200': + description: '' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CoverLetterList' + tags: + - covers + /api/covers/{id}/: + get: + description: Show a cover letter. + operationId: covers_read + parameters: + - in: path + name: id + required: true + schema: + description: '' + title: '' + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CoverLetterDetail' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - covers /api/people/: get: description: List people. @@ -462,6 +532,20 @@ components: description: A search term. title: Search type: string + BeforeFilter: + in: query + name: before + schema: + description: '' + title: '' + type: string + SinceFilter: + in: query + name: since + schema: + description: '' + title: '' + type: string headers: Link: description: | @@ -554,6 +638,69 @@ components: type: string format: uri readOnly: true + CoverLetterList: + 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' + 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 + submitter: + $ref: '#/components/schemas/PersonEmbedded' + mbox: + title: Mbox + type: string + format: uri + readOnly: true + series: + $ref: '#/components/schemas/SeriesEmbedded' + comments: + title: Comments + type: string + format: uri + readOnly: true + CoverLetterDetail: + allOf: + - $ref: '#/components/schemas/CoverLetterList' + - properties: + headers: + title: Headers + type: array + items: + type: string + readOnly: true + content: + title: Content + type: string + readOnly: true + minLength: 1 Person: type: object properties: @@ -715,6 +862,29 @@ components: type: string format: uri readOnly: true + PersonEmbedded: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + email: + title: Email + type: string + format: email + readOnly: true + minLength: 1 ProjectEmbedded: type: object properties: @@ -769,6 +939,46 @@ components: format: uri readOnly: true maxLength: 2000 + SeriesEmbedded: + 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 + name: + title: Name + description: An optional name to associate with the series, e.g. "John's PCI + series". + type: string + readOnly: true + maxLength: 255 + x-nullable: true + date: + title: Date + type: string + format: date-time + readOnly: true + version: + title: Version + description: Version of series as indicated by the subject prefix(es) + type: integer + readOnly: true + mbox: + title: Mbox + type: string + format: uri + readOnly: true UserEmbedded: type: object properties: