From 63591016b3ecd79ab1172cd98e2e830a09d6f515 Mon Sep 17 00:00:00 2001 From: zeripath Date: Sat, 11 Jul 2020 22:46:01 +0100 Subject: Extend Notifications API and return pinned notifications by default (#12164) * Extend notifications API and return pinned notifications in notifications list Signed-off-by: Andrew Thornton * fix swagger Signed-off-by: Andrew Thornton * Fix swagger again Signed-off-by: Andrew Thornton * fix test Signed-off-by: Andrew Thornton * remove spurious debugs * as per @6543 Signed-off-by: Andrew Thornton * Update models/notification.go * as per @6543 Signed-off-by: Andrew Thornton Co-authored-by: techknowlogick --- templates/swagger/v1_json.tmpl | 75 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 2 deletions(-) (limited to 'templates') diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 9290bfe079..795e179cb9 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -459,6 +459,16 @@ "name": "all", "in": "query" }, + { + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.", + "name": "status-types", + "in": "query" + }, { "type": "string", "format": "date-time", @@ -502,7 +512,7 @@ "tags": [ "notification" ], - "summary": "Mark notification threads as read", + "summary": "Mark notification threads as read, pinned or unread", "operationId": "notifyReadList", "parameters": [ { @@ -511,6 +521,28 @@ "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.", "name": "last_read_at", "in": "query" + }, + { + "type": "string", + "description": "If true, mark all notifications on this repo. Default value is false", + "name": "all", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.", + "name": "status-types", + "in": "query" + }, + { + "type": "string", + "description": "Status to mark notifications as, Defaults to read.", + "name": "to-status", + "in": "query" } ], "responses": { @@ -587,6 +619,13 @@ "name": "id", "in": "path", "required": true + }, + { + "type": "string", + "default": "read", + "description": "Status to mark notifications as", + "name": "to-status", + "in": "query" } ], "responses": { @@ -6382,6 +6421,16 @@ "name": "all", "in": "query" }, + { + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned", + "name": "status-types", + "in": "query" + }, { "type": "string", "format": "date-time", @@ -6425,7 +6474,7 @@ "tags": [ "notification" ], - "summary": "Mark notification threads as read on a specific repo", + "summary": "Mark notification threads as read, pinned or unread on a specific repo", "operationId": "notifyReadRepoList", "parameters": [ { @@ -6442,6 +6491,28 @@ "in": "path", "required": true }, + { + "type": "string", + "description": "If true, mark all notifications on this repo. Default value is false", + "name": "all", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.", + "name": "status-types", + "in": "query" + }, + { + "type": "string", + "description": "Status to mark notifications as. Defaults to read.", + "name": "to-status", + "in": "query" + }, { "type": "string", "format": "date-time", -- cgit v1.2.3