diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index b95471e06e..4ceef577f7 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -6111,7 +6111,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" ], @@ -6197,7 +6197,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -6246,7 +6246,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" ], @@ -39718,7 +39718,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" ], @@ -39787,7 +39787,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" ], @@ -112789,7 +112789,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 71817e7b79..15f9f45818 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -4211,12 +4211,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 @@ -4277,7 +4276,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 @@ -4309,7 +4308,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 @@ -28675,7 +28675,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 @@ -28713,11 +28713,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`. @@ -85361,7 +85360,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-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 8a5f133e45..22aa9f4d57 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -54111,7 +54111,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" ], @@ -54245,7 +54245,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -54257,7 +54257,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": { @@ -55237,7 +55237,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" ], @@ -55249,7 +55249,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": { @@ -55314,7 +55314,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": { @@ -55479,7 +55479,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": { @@ -55668,7 +55668,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": { @@ -349756,7 +349756,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" ], @@ -350773,7 +350773,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-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 7be48f80dd..73d4f11cdb 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -13969,12 +13969,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 @@ -14034,7 +14033,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 @@ -14044,7 +14043,9 @@ paths: parameters: - &91 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: @@ -14147,7 +14148,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 @@ -60490,7 +60492,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 @@ -60525,11 +60527,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-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 29c4d06902..04f8832ba1 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -55122,7 +55122,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" ], @@ -55256,7 +55256,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -55268,7 +55268,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": { @@ -56248,7 +56248,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" ], @@ -56260,7 +56260,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": { @@ -56325,7 +56325,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": { @@ -56490,7 +56490,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": { @@ -56679,7 +56679,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": { @@ -353215,7 +353215,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" ], @@ -354232,7 +354232,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-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 35f6309ca2..3eb7ee0628 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -14662,8 +14662,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 @@ -14727,7 +14726,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 @@ -14737,7 +14736,9 @@ paths: parameters: - &91 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: @@ -14840,7 +14841,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 @@ -62013,7 +62016,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 @@ -62048,11 +62051,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-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 97cda8c16f..ecf496096e 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -6457,7 +6457,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" ], @@ -6543,7 +6543,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -6592,7 +6592,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" ], @@ -40954,7 +40954,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" ], @@ -41023,7 +41023,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" ], @@ -116162,7 +116162,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-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index c8b81b2059..0df0a4ce13 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -4451,8 +4451,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 @@ -4517,7 +4516,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 @@ -4549,7 +4548,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 @@ -29537,7 +29538,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 @@ -29575,11 +29576,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`. @@ -87738,7 +87738,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-next/ghes-3.2/dereferenced/ghes-3.2.deref.json b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json index f85d716078..d1b6d4547b 100644 --- a/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json +++ b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json @@ -64171,7 +64171,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" ], @@ -64305,7 +64305,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -64317,7 +64317,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": { @@ -65285,7 +65285,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" ], @@ -65297,7 +65297,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": { @@ -65362,7 +65362,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": { @@ -65527,7 +65527,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": { @@ -65716,7 +65716,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": { @@ -300505,7 +300505,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" ], @@ -301510,7 +301510,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-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml index 3e76c4c309..6a4f4c7a80 100644 --- a/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml +++ b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml @@ -15039,8 +15039,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 @@ -15104,7 +15103,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 @@ -15114,7 +15113,9 @@ paths: parameters: - &98 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: @@ -15217,7 +15218,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 @@ -51401,7 +51404,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 @@ -51436,11 +51439,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-next/ghes-3.2/ghes-3.2.json b/descriptions-next/ghes-3.2/ghes-3.2.json index fddc3a409f..1092478b1b 100644 --- a/descriptions-next/ghes-3.2/ghes-3.2.json +++ b/descriptions-next/ghes-3.2/ghes-3.2.json @@ -8763,7 +8763,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" ], @@ -8849,7 +8849,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -8898,7 +8898,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" ], @@ -34804,7 +34804,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" ], @@ -34873,7 +34873,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" ], @@ -96478,7 +96478,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-next/ghes-3.2/ghes-3.2.yaml b/descriptions-next/ghes-3.2/ghes-3.2.yaml index 38069872be..3acf5ff0f8 100644 --- a/descriptions-next/ghes-3.2/ghes-3.2.yaml +++ b/descriptions-next/ghes-3.2/ghes-3.2.yaml @@ -6183,8 +6183,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 @@ -6249,7 +6248,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 @@ -6281,7 +6280,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 @@ -25327,7 +25328,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 @@ -25365,11 +25366,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`. @@ -73395,7 +73395,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-next/ghes-3.3/dereferenced/ghes-3.3.deref.json b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json index 259f6e7762..d7e7c7f927 100644 --- a/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json +++ b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json @@ -64483,7 +64483,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" ], @@ -64617,7 +64617,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -64629,7 +64629,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": { @@ -65597,7 +65597,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" ], @@ -65609,7 +65609,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": { @@ -65674,7 +65674,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": { @@ -65839,7 +65839,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": { @@ -66028,7 +66028,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": { @@ -302690,7 +302690,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" ], @@ -303695,7 +303695,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-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml index 72bbc27a6f..8aa6dd5a6d 100644 --- a/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml +++ b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml @@ -15246,8 +15246,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 @@ -15311,7 +15310,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 @@ -15321,7 +15320,9 @@ paths: parameters: - &96 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: @@ -15424,7 +15425,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 @@ -51997,7 +52000,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 @@ -52032,11 +52035,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-next/ghes-3.3/ghes-3.3.json b/descriptions-next/ghes-3.3/ghes-3.3.json index 5dbcbaacd4..c65255c384 100644 --- a/descriptions-next/ghes-3.3/ghes-3.3.json +++ b/descriptions-next/ghes-3.3/ghes-3.3.json @@ -8643,7 +8643,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" ], @@ -8729,7 +8729,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -8778,7 +8778,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" ], @@ -34644,7 +34644,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" ], @@ -34713,7 +34713,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" ], @@ -96999,7 +96999,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-next/ghes-3.3/ghes-3.3.yaml b/descriptions-next/ghes-3.3/ghes-3.3.yaml index c6b1a371fc..cb82d396c5 100644 --- a/descriptions-next/ghes-3.3/ghes-3.3.yaml +++ b/descriptions-next/ghes-3.3/ghes-3.3.yaml @@ -5984,8 +5984,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 @@ -6050,7 +6049,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 @@ -6082,7 +6081,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 @@ -24616,7 +24617,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 @@ -24654,11 +24655,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`. @@ -72894,7 +72894,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-next/ghes-3.4/dereferenced/ghes-3.4.deref.json b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json index dfb977226a..cded680c6b 100644 --- a/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json +++ b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json @@ -64750,7 +64750,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" ], @@ -64884,7 +64884,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -64896,7 +64896,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": { @@ -65864,7 +65864,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" ], @@ -65876,7 +65876,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": { @@ -65941,7 +65941,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": { @@ -66106,7 +66106,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": { @@ -66295,7 +66295,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": { @@ -317909,7 +317909,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" ], @@ -318914,7 +318914,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-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml index ba8c9b8bc3..90043f90bf 100644 --- a/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml +++ b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml @@ -16132,8 +16132,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 @@ -16197,7 +16196,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 @@ -16207,7 +16206,9 @@ paths: parameters: - &99 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: @@ -16310,7 +16311,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 @@ -54297,7 +54300,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 @@ -54332,11 +54335,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-next/ghes-3.4/ghes-3.4.json b/descriptions-next/ghes-3.4/ghes-3.4.json index d731c36e97..5c840ae8bf 100644 --- a/descriptions-next/ghes-3.4/ghes-3.4.json +++ b/descriptions-next/ghes-3.4/ghes-3.4.json @@ -8854,7 +8854,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" ], @@ -8940,7 +8940,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -8989,7 +8989,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" ], @@ -36513,7 +36513,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" ], @@ -36582,7 +36582,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" ], @@ -100765,7 +100765,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-next/ghes-3.4/ghes-3.4.yaml b/descriptions-next/ghes-3.4/ghes-3.4.yaml index 024e8b2a68..ba1f37996f 100644 --- a/descriptions-next/ghes-3.4/ghes-3.4.yaml +++ b/descriptions-next/ghes-3.4/ghes-3.4.yaml @@ -6126,8 +6126,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 @@ -6192,7 +6191,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 @@ -6224,7 +6223,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 @@ -26120,7 +26121,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 @@ -26158,11 +26159,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`. @@ -75915,7 +75915,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-next/ghes-3.5/dereferenced/ghes-3.5.deref.json b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json index 69b11035cf..231dba403f 100644 --- a/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json +++ b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json @@ -65126,7 +65126,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" ], @@ -65260,7 +65260,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -65272,7 +65272,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": { @@ -66246,7 +66246,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" ], @@ -66258,7 +66258,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": { @@ -66323,7 +66323,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": { @@ -66488,7 +66488,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": { @@ -66677,7 +66677,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": { @@ -325310,7 +325310,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" ], @@ -326321,7 +326321,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-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml index acc9edd540..10048a5a3a 100644 --- a/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml +++ b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml @@ -16342,8 +16342,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 @@ -16407,7 +16406,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 @@ -16417,7 +16416,9 @@ paths: parameters: - &101 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: @@ -16520,7 +16521,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 @@ -55706,7 +55709,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 @@ -55741,11 +55744,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-next/ghes-3.5/ghes-3.5.json b/descriptions-next/ghes-3.5/ghes-3.5.json index ac1d1b65d5..5cda5a670a 100644 --- a/descriptions-next/ghes-3.5/ghes-3.5.json +++ b/descriptions-next/ghes-3.5/ghes-3.5.json @@ -9023,7 +9023,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" ], @@ -9109,7 +9109,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -9158,7 +9158,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" ], @@ -37590,7 +37590,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" ], @@ -37659,7 +37659,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" ], @@ -102932,7 +102932,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-next/ghes-3.5/ghes-3.5.yaml b/descriptions-next/ghes-3.5/ghes-3.5.yaml index 82e9cb1c56..0912ce7305 100644 --- a/descriptions-next/ghes-3.5/ghes-3.5.yaml +++ b/descriptions-next/ghes-3.5/ghes-3.5.yaml @@ -6255,8 +6255,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 @@ -6321,7 +6320,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 @@ -6353,7 +6352,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 @@ -26874,7 +26875,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 @@ -26912,11 +26913,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`. @@ -77549,7 +77549,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-next/ghes-3.6/dereferenced/ghes-3.6.deref.json b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json index 87169ef8e6..3393466a95 100644 --- a/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json +++ b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json @@ -66063,7 +66063,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" ], @@ -66197,7 +66197,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -66209,7 +66209,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": { @@ -67189,7 +67189,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" ], @@ -67201,7 +67201,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": { @@ -67266,7 +67266,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": { @@ -67431,7 +67431,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": { @@ -67620,7 +67620,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": { @@ -331025,7 +331025,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" ], @@ -332042,7 +332042,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-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml index 530129b47a..ffa99e9c1d 100644 --- a/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml +++ b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml @@ -16571,8 +16571,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 @@ -16636,7 +16635,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 @@ -16646,7 +16645,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.6/rest/reference/activity#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -16749,7 +16750,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 @@ -56667,7 +56670,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 @@ -56702,11 +56705,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-next/ghes-3.6/ghes-3.6.json b/descriptions-next/ghes-3.6/ghes-3.6.json index e61f1176dc..fb23ccc127 100644 --- a/descriptions-next/ghes-3.6/ghes-3.6.json +++ b/descriptions-next/ghes-3.6/ghes-3.6.json @@ -9117,7 +9117,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" ], @@ -9203,7 +9203,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -9252,7 +9252,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" ], @@ -38150,7 +38150,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" ], @@ -38219,7 +38219,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" ], @@ -105881,7 +105881,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-next/ghes-3.6/ghes-3.6.yaml b/descriptions-next/ghes-3.6/ghes-3.6.yaml index c5593d3b18..362f90a61f 100644 --- a/descriptions-next/ghes-3.6/ghes-3.6.yaml +++ b/descriptions-next/ghes-3.6/ghes-3.6.yaml @@ -6324,8 +6324,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 @@ -6390,7 +6389,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 @@ -6422,7 +6421,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 @@ -27285,7 +27286,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 @@ -27323,11 +27324,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`. @@ -79675,7 +79675,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-next/github.ae/dereferenced/github.ae.deref.json b/descriptions-next/github.ae/dereferenced/github.ae.deref.json index 9b125cdb39..08a4354e38 100644 --- a/descriptions-next/github.ae/dereferenced/github.ae.deref.json +++ b/descriptions-next/github.ae/dereferenced/github.ae.deref.json @@ -43530,7 +43530,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" ], @@ -43664,7 +43664,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -43676,7 +43676,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": { @@ -44656,7 +44656,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" ], @@ -44668,7 +44668,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": { @@ -44733,7 +44733,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": { @@ -44898,7 +44898,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": { @@ -45087,7 +45087,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": { @@ -286514,7 +286514,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" ], @@ -287531,7 +287531,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-next/github.ae/dereferenced/github.ae.deref.yaml b/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml index abcad5bce3..8dfa8adb03 100644 --- a/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml +++ b/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml @@ -12840,12 +12840,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 @@ -12905,7 +12904,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 @@ -12915,7 +12914,9 @@ paths: parameters: - &80 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: @@ -13018,7 +13019,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 @@ -49665,7 +49667,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 @@ -49700,11 +49702,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-next/github.ae/github.ae.json b/descriptions-next/github.ae/github.ae.json index 5efb24acf7..5bff24d847 100644 --- a/descriptions-next/github.ae/github.ae.json +++ b/descriptions-next/github.ae/github.ae.json @@ -6491,7 +6491,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" ], @@ -6577,7 +6577,7 @@ "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", - "description": "", + "description": "Gets information about a notification thread.", "tags": [ "activity" ], @@ -6626,7 +6626,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" ], @@ -32202,7 +32202,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" ], @@ -32271,7 +32271,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" ], @@ -90668,7 +90668,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-next/github.ae/github.ae.yaml b/descriptions-next/github.ae/github.ae.yaml index 9dc0e7b4ea..9ca4e91003 100644 --- a/descriptions-next/github.ae/github.ae.yaml +++ b/descriptions-next/github.ae/github.ae.yaml @@ -4443,12 +4443,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 @@ -4509,7 +4508,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 @@ -4541,7 +4540,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 @@ -23040,7 +23040,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 @@ -23078,11 +23078,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`. @@ -68515,7 +68514,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: