From 4978029f5c0f7a3df4f231ab0b07aeb532867691 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Fri, 30 Sep 2022 06:23:01 -0700 Subject: [PATCH] Update OpenAPI 3.0 Descriptions --- .../api.github.com/api.github.com.json | 12 +++---- .../api.github.com/api.github.com.yaml | 31 ++++++++++--------- .../dereferenced/api.github.com.deref.json | 20 ++++++------ .../dereferenced/api.github.com.deref.yaml | 31 ++++++++++--------- .../ghec/dereferenced/ghec.deref.json | 20 ++++++------ .../ghec/dereferenced/ghec.deref.yaml | 24 +++++++------- descriptions/ghec/ghec.json | 12 +++---- descriptions/ghec/ghec.yaml | 24 +++++++------- .../ghes-3.2/dereferenced/ghes-3.2.deref.json | 20 ++++++------ .../ghes-3.2/dereferenced/ghes-3.2.deref.yaml | 24 +++++++------- descriptions/ghes-3.2/ghes-3.2.json | 12 +++---- descriptions/ghes-3.2/ghes-3.2.yaml | 24 +++++++------- .../ghes-3.3/dereferenced/ghes-3.3.deref.json | 20 ++++++------ .../ghes-3.3/dereferenced/ghes-3.3.deref.yaml | 24 +++++++------- descriptions/ghes-3.3/ghes-3.3.json | 12 +++---- descriptions/ghes-3.3/ghes-3.3.yaml | 24 +++++++------- .../ghes-3.4/dereferenced/ghes-3.4.deref.json | 20 ++++++------ .../ghes-3.4/dereferenced/ghes-3.4.deref.yaml | 24 +++++++------- descriptions/ghes-3.4/ghes-3.4.json | 12 +++---- descriptions/ghes-3.4/ghes-3.4.yaml | 24 +++++++------- .../ghes-3.5/dereferenced/ghes-3.5.deref.json | 20 ++++++------ .../ghes-3.5/dereferenced/ghes-3.5.deref.yaml | 24 +++++++------- descriptions/ghes-3.5/ghes-3.5.json | 12 +++---- descriptions/ghes-3.5/ghes-3.5.yaml | 24 +++++++------- .../ghes-3.6/dereferenced/ghes-3.6.deref.json | 20 ++++++------ .../ghes-3.6/dereferenced/ghes-3.6.deref.yaml | 24 +++++++------- descriptions/ghes-3.6/ghes-3.6.json | 12 +++---- descriptions/ghes-3.6/ghes-3.6.yaml | 24 +++++++------- .../dereferenced/github.ae.deref.json | 20 ++++++------ .../dereferenced/github.ae.deref.yaml | 31 ++++++++++--------- descriptions/github.ae/github.ae.json | 12 +++---- descriptions/github.ae/github.ae.yaml | 31 ++++++++++--------- 32 files changed, 348 insertions(+), 320 deletions(-) diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index e5b55b4565..991675a8b0 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -6069,7 +6069,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -6155,7 +6155,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -6204,7 +6204,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.", "tags": [ "activity" ], @@ -39497,7 +39497,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -39566,7 +39566,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -110008,7 +110008,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index a2a926f431..f1786f88ca 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -4192,12 +4192,11 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub](https://github.com/notifications). If the number of notifications - is too large to complete in one request, you will receive a `202 Accepted` - status and GitHub will run an asynchronous process to mark notifications as - "read." To check whether any "unread" notifications remain, you can use the - [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) + description: Marks all notifications as "read" for the current user. If the + number of notifications is too large to complete in one request, you will + receive a `202 Accepted` status and GitHub will run an asynchronous process + to mark notifications as "read." To check whether any "unread" notifications + remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity @@ -4258,7 +4257,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -4290,7 +4289,8 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -28564,7 +28564,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -28602,11 +28602,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub](https://github.com/notifications). If the - number of notifications is too large to complete in one request, you will - receive a `202 Accepted` status and GitHub will run an asynchronous process - to mark notifications as "read." To check whether any "unread" notifications + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub will run an asynchronous + process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -84835,7 +84834,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index e3582cb618..14c76d20e6 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -46667,7 +46667,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -46801,7 +46801,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -46813,7 +46813,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -47619,7 +47619,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.", "tags": [ "activity" ], @@ -47631,7 +47631,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -47696,7 +47696,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -47847,7 +47847,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -48022,7 +48022,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -294811,7 +294811,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -295654,7 +295654,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 0a840d5c94..40fe301b0f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -13538,12 +13538,11 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub](https://github.com/notifications). If the number of notifications - is too large to complete in one request, you will receive a `202 Accepted` - status and GitHub will run an asynchronous process to mark notifications as - "read." To check whether any "unread" notifications remain, you can use the - [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) + description: Marks all notifications as "read" for the current user. If the + number of notifications is too large to complete in one request, you will + receive a `202 Accepted` status and GitHub will run an asynchronous process + to mark notifications as "read." To check whether any "unread" notifications + remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity @@ -13603,7 +13602,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -13613,7 +13612,9 @@ paths: parameters: - &95 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -13716,7 +13717,8 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -59100,7 +59102,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -59135,11 +59137,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub](https://github.com/notifications). If the - number of notifications is too large to complete in one request, you will - receive a `202 Accepted` status and GitHub will run an asynchronous process - to mark notifications as "read." To check whether any "unread" notifications + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub will run an asynchronous + process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 39b6aa294e..d6a5336895 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -47664,7 +47664,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Cloud](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -47798,7 +47798,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -47810,7 +47810,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -48616,7 +48616,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications.", "tags": [ "activity" ], @@ -48628,7 +48628,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -48693,7 +48693,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -48844,7 +48844,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -49019,7 +49019,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -298124,7 +298124,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -298967,7 +298967,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Cloud](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 7b57ae7d26..0e9a17f127 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -14224,8 +14224,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Cloud](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -14289,7 +14288,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -14299,7 +14298,9 @@ paths: parameters: - &95 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -14402,7 +14403,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Cloud: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -60582,7 +60585,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -60617,11 +60620,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Cloud](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Cloud will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Cloud will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 14b00d1dc4..03a7b469ab 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -6415,7 +6415,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Cloud](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -6501,7 +6501,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -6550,7 +6550,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications.", "tags": [ "activity" ], @@ -40731,7 +40731,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -40800,7 +40800,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Cloud](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -113237,7 +113237,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index c213fa6570..aecfa186bd 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -4432,8 +4432,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Cloud](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -4498,7 +4497,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -4530,7 +4529,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Cloud: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -29425,7 +29426,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -29463,11 +29464,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Cloud](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Cloud will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Cloud will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -87140,7 +87140,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json index 540d388154..58f862276b 100644 --- a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json +++ b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json @@ -55595,7 +55595,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -55729,7 +55729,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -55741,7 +55741,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -56539,7 +56539,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -56551,7 +56551,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -56616,7 +56616,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -56767,7 +56767,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -56942,7 +56942,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -252578,7 +252578,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -253413,7 +253413,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml index d57edf3dd0..ae26e3a691 100644 --- a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml +++ b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml @@ -14622,8 +14622,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -14687,7 +14686,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -14697,7 +14696,9 @@ paths: parameters: - &105 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -14800,7 +14801,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -50210,7 +50213,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -50245,11 +50248,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghes-3.2/ghes-3.2.json b/descriptions/ghes-3.2/ghes-3.2.json index 49edc602bb..61fa2590eb 100644 --- a/descriptions/ghes-3.2/ghes-3.2.json +++ b/descriptions/ghes-3.2/ghes-3.2.json @@ -8702,7 +8702,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -8788,7 +8788,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -8837,7 +8837,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -34600,7 +34600,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -34669,7 +34669,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -93911,7 +93911,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-3.2/ghes-3.2.yaml b/descriptions/ghes-3.2/ghes-3.2.yaml index d1ccec28d3..71e491ff5a 100644 --- a/descriptions/ghes-3.2/ghes-3.2.yaml +++ b/descriptions/ghes-3.2/ghes-3.2.yaml @@ -6156,8 +6156,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -6222,7 +6221,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -6254,7 +6253,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -25226,7 +25227,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -25264,11 +25265,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -72770,7 +72770,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.json b/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.json index 7cd53f69f5..8b237edbde 100644 --- a/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.json +++ b/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.json @@ -55893,7 +55893,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -56027,7 +56027,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -56039,7 +56039,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -56837,7 +56837,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -56849,7 +56849,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -56914,7 +56914,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57065,7 +57065,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57240,7 +57240,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -254435,7 +254435,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -255270,7 +255270,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.yaml b/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.yaml index 1cd3f63c14..a9be4df8e5 100644 --- a/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.yaml +++ b/descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.yaml @@ -14828,8 +14828,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -14893,7 +14892,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -14903,7 +14902,9 @@ paths: parameters: - &103 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -15006,7 +15007,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -50747,7 +50750,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -50782,11 +50785,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghes-3.3/ghes-3.3.json b/descriptions/ghes-3.3/ghes-3.3.json index 128f276b87..9e7cf996cf 100644 --- a/descriptions/ghes-3.3/ghes-3.3.json +++ b/descriptions/ghes-3.3/ghes-3.3.json @@ -8582,7 +8582,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -8668,7 +8668,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -8717,7 +8717,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -34440,7 +34440,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -34509,7 +34509,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -94304,7 +94304,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-3.3/ghes-3.3.yaml b/descriptions/ghes-3.3/ghes-3.3.yaml index a4a275d717..157a1640e9 100644 --- a/descriptions/ghes-3.3/ghes-3.3.yaml +++ b/descriptions/ghes-3.3/ghes-3.3.yaml @@ -5957,8 +5957,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -6023,7 +6022,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -6055,7 +6054,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -24515,7 +24516,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -24553,11 +24554,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -72213,7 +72213,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.json b/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.json index 2df6f96a09..7424704223 100644 --- a/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.json +++ b/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.json @@ -56204,7 +56204,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -56338,7 +56338,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -56350,7 +56350,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57148,7 +57148,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -57160,7 +57160,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57225,7 +57225,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57376,7 +57376,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57551,7 +57551,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -267354,7 +267354,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -268189,7 +268189,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.yaml b/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.yaml index 593dcfa8a7..5f5be16798 100644 --- a/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.yaml +++ b/descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.yaml @@ -15660,8 +15660,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -15725,7 +15724,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -15735,7 +15734,9 @@ paths: parameters: - &104 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -15838,7 +15839,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -53022,7 +53025,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -53057,11 +53060,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghes-3.4/ghes-3.4.json b/descriptions/ghes-3.4/ghes-3.4.json index 667bd4c342..ae1e56b523 100644 --- a/descriptions/ghes-3.4/ghes-3.4.json +++ b/descriptions/ghes-3.4/ghes-3.4.json @@ -8800,7 +8800,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -8886,7 +8886,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -8935,7 +8935,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -36304,7 +36304,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -36373,7 +36373,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -97893,7 +97893,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-3.4/ghes-3.4.yaml b/descriptions/ghes-3.4/ghes-3.4.yaml index 26a00f6f3f..f0e2ead363 100644 --- a/descriptions/ghes-3.4/ghes-3.4.yaml +++ b/descriptions/ghes-3.4/ghes-3.4.yaml @@ -6101,8 +6101,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -6167,7 +6166,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -6199,7 +6198,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -26015,7 +26016,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -26053,11 +26054,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -75118,7 +75118,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.json b/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.json index 1e852401b3..8ba99669be 100644 --- a/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.json +++ b/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.json @@ -56558,7 +56558,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -56692,7 +56692,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -56704,7 +56704,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57506,7 +57506,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -57518,7 +57518,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57583,7 +57583,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57734,7 +57734,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -57909,7 +57909,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -273597,7 +273597,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -274436,7 +274436,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.yaml b/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.yaml index b18ac456ef..c831668523 100644 --- a/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.yaml +++ b/descriptions/ghes-3.5/dereferenced/ghes-3.5.deref.yaml @@ -15864,8 +15864,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -15929,7 +15928,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -15939,7 +15938,9 @@ paths: parameters: - &106 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -16042,7 +16043,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -54405,7 +54408,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -54440,11 +54443,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghes-3.5/ghes-3.5.json b/descriptions/ghes-3.5/ghes-3.5.json index ea79af248d..f895c35482 100644 --- a/descriptions/ghes-3.5/ghes-3.5.json +++ b/descriptions/ghes-3.5/ghes-3.5.json @@ -8965,7 +8965,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -9051,7 +9051,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -9100,7 +9100,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -37369,7 +37369,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -37438,7 +37438,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -99989,7 +99989,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-3.5/ghes-3.5.yaml b/descriptions/ghes-3.5/ghes-3.5.yaml index e2d8a4ebdc..3c511241ce 100644 --- a/descriptions/ghes-3.5/ghes-3.5.yaml +++ b/descriptions/ghes-3.5/ghes-3.5.yaml @@ -6228,8 +6228,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -6294,7 +6293,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -6326,7 +6325,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -26763,7 +26764,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -26801,11 +26802,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -76720,7 +76720,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.json b/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.json index d13aca3720..be22c31139 100644 --- a/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.json +++ b/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.json @@ -57441,7 +57441,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -57575,7 +57575,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -57587,7 +57587,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -58393,7 +58393,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -58405,7 +58405,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -58470,7 +58470,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -58621,7 +58621,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -58796,7 +58796,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -279004,7 +279004,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -279847,7 +279847,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.yaml b/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.yaml index 1e948bc04b..6f69d60281 100644 --- a/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.yaml +++ b/descriptions/ghes-3.6/dereferenced/ghes-3.6.deref.yaml @@ -16093,8 +16093,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -16158,7 +16157,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -16168,7 +16167,9 @@ paths: parameters: - &109 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -16271,7 +16272,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -55327,7 +55330,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -55362,11 +55365,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/ghes-3.6/ghes-3.6.json b/descriptions/ghes-3.6/ghes-3.6.json index e6cdd3cade..e6985a0e27 100644 --- a/descriptions/ghes-3.6/ghes-3.6.json +++ b/descriptions/ghes-3.6/ghes-3.6.json @@ -9059,7 +9059,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -9145,7 +9145,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -9194,7 +9194,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "tags": [ "activity" ], @@ -37927,7 +37927,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -37996,7 +37996,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -102906,7 +102906,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-3.6/ghes-3.6.yaml b/descriptions/ghes-3.6/ghes-3.6.yaml index d68ba87157..6bd2357823 100644 --- a/descriptions/ghes-3.6/ghes-3.6.yaml +++ b/descriptions/ghes-3.6/ghes-3.6.yaml @@ -6297,8 +6297,7 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub Enterprise Server](https://github.com/notifications). If the + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications @@ -6363,7 +6362,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -6395,7 +6394,9 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub Enterprise + Server: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -27173,7 +27174,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -27211,11 +27212,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub Enterprise Server](https://github.com/notifications). - If the number of notifications is too large to complete in one request, you - will receive a `202 Accepted` status and GitHub Enterprise Server will run - an asynchronous process to mark notifications as "read." To check whether + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub Enterprise Server will + run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -78893,7 +78893,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: diff --git a/descriptions/github.ae/dereferenced/github.ae.deref.json b/descriptions/github.ae/dereferenced/github.ae.deref.json index 788b8154ce..1c3bbba39c 100644 --- a/descriptions/github.ae/dereferenced/github.ae.deref.json +++ b/descriptions/github.ae/dereferenced/github.ae.deref.json @@ -38113,7 +38113,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub AE](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -38247,7 +38247,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -38259,7 +38259,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -39065,7 +39065,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub AE: https://github.com/notifications.", "tags": [ "activity" ], @@ -39077,7 +39077,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -39142,7 +39142,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -39293,7 +39293,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -39468,7 +39468,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -240348,7 +240348,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -241191,7 +241191,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub AE](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], diff --git a/descriptions/github.ae/dereferenced/github.ae.deref.yaml b/descriptions/github.ae/dereferenced/github.ae.deref.yaml index 6d180fb9c7..2174fff943 100644 --- a/descriptions/github.ae/dereferenced/github.ae.deref.yaml +++ b/descriptions/github.ae/dereferenced/github.ae.deref.yaml @@ -12477,12 +12477,11 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub AE](https://github.com/notifications). If the number of notifications - is too large to complete in one request, you will receive a `202 Accepted` - status and GitHub AE will run an asynchronous process to mark notifications - as "read." To check whether any "unread" notifications remain, you can use - the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) + description: Marks all notifications as "read" for the current user. If the + number of notifications is too large to complete in one request, you will + receive a `202 Accepted` status and GitHub AE will run an asynchronous process + to mark notifications as "read." To check whether any "unread" notifications + remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity @@ -12542,7 +12541,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -12552,7 +12551,9 @@ paths: parameters: - &85 name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -12655,7 +12656,8 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub AE: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -48483,7 +48485,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -48518,11 +48520,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub AE](https://github.com/notifications). If - the number of notifications is too large to complete in one request, you will - receive a `202 Accepted` status and GitHub AE will run an asynchronous process - to mark notifications as "read." To check whether any "unread" notifications + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub AE will run an asynchronous + process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. diff --git a/descriptions/github.ae/github.ae.json b/descriptions/github.ae/github.ae.json index 6e9730bba2..8b6f706728 100644 --- a/descriptions/github.ae/github.ae.json +++ b/descriptions/github.ae/github.ae.json @@ -6461,7 +6461,7 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub AE](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -6547,7 +6547,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -6596,7 +6596,7 @@ }, "patch": { "summary": "Mark a thread as read", - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub AE: https://github.com/notifications.", "tags": [ "activity" ], @@ -32023,7 +32023,7 @@ "/repos/{owner}/{repo}/notifications": { "get": { "summary": "List repository notifications for the authenticated user", - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "tags": [ "activity" ], @@ -32092,7 +32092,7 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub AE](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], @@ -88104,7 +88104,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { diff --git a/descriptions/github.ae/github.ae.yaml b/descriptions/github.ae/github.ae.yaml index 6240773f72..cb9006a0b5 100644 --- a/descriptions/github.ae/github.ae.yaml +++ b/descriptions/github.ae/github.ae.yaml @@ -4430,12 +4430,11 @@ paths: subcategory: notifications put: summary: Mark notifications as read - description: Marks all notifications as "read" removes it from the [default - view on GitHub AE](https://github.com/notifications). If the number of notifications - is too large to complete in one request, you will receive a `202 Accepted` - status and GitHub AE will run an asynchronous process to mark notifications - as "read." To check whether any "unread" notifications remain, you can use - the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) + description: Marks all notifications as "read" for the current user. If the + number of notifications is too large to complete in one request, you will + receive a `202 Accepted` status and GitHub AE will run an asynchronous process + to mark notifications as "read." To check whether any "unread" notifications + remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity @@ -4496,7 +4495,7 @@ paths: "/notifications/threads/{thread_id}": get: summary: Get a thread - description: '' + description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread @@ -4528,7 +4527,8 @@ paths: subcategory: notifications patch: summary: Mark a thread as read - description: '' + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent + to clicking a notification in your notification inbox on GitHub AE: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read @@ -22950,7 +22950,7 @@ paths: "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user - description: List all notifications for the current user. + description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user @@ -22988,11 +22988,10 @@ paths: subcategory: notifications put: summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" removes them - from the [default view on GitHub AE](https://github.com/notifications). If - the number of notifications is too large to complete in one request, you will - receive a `202 Accepted` status and GitHub AE will run an asynchronous process - to mark notifications as "read." To check whether any "unread" notifications + description: Marks all notifications in a repository as "read" for the current + user. If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub AE will run an asynchronous + process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. @@ -67868,7 +67867,9 @@ components: format: date-time thread-id: name: thread_id - description: The unique identifier of the pull request thread. + description: The unique identifier of the notification thread. This corresponds + to the value returned in the `id` field when you retrieve notifications (for + example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: