diff options
Diffstat (limited to 'templates/swagger/v1_json.tmpl')
| -rw-r--r-- | templates/swagger/v1_json.tmpl | 75 |
1 files changed, 73 insertions, 2 deletions
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 @@ -460,6 +460,16 @@ "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", "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", @@ -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": { @@ -6383,6 +6422,16 @@ "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", "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", @@ -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": [ { @@ -6444,6 +6493,28 @@ }, { "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", "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.", "name": "last_read_at", |