From 4564be9017560e5a4bf147f96ba7a560c1c2898e Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Tue, 29 Apr 2025 23:37:52 -0700 Subject: [PATCH 1/2] Update OpenAPI Description (#55446) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 6 +++--- src/rest/data/ghec-2022-11-28/schema.json | 6 +++--- src/rest/data/ghes-3.12-2022-11-28/schema.json | 6 +++--- src/rest/data/ghes-3.13-2022-11-28/schema.json | 6 +++--- src/rest/data/ghes-3.14-2022-11-28/schema.json | 6 +++--- src/rest/data/ghes-3.15-2022-11-28/schema.json | 6 +++--- src/rest/data/ghes-3.16-2022-11-28/schema.json | 6 +++--- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 10 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index d5b0747c896b..f0dc1f1bb311 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424" + "sha": "1c22f3361af92533fad97262cf4b7c18574f22a6" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 3f796952b247..a850ae9e8a06 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -243506,7 +243506,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -245439,7 +245439,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -247397,7 +247397,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index afcd22afbd6a..41feacc14258 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -256826,7 +256826,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -258759,7 +258759,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -260717,7 +260717,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 423446f67fc9..be6f239a0b9f 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -179225,7 +179225,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -181109,7 +181109,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -183010,7 +183010,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 290538c6c1a7..666fa8e05dd4 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -179369,7 +179369,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -181253,7 +181253,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -183154,7 +183154,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 1cb18cb24aeb..d3b2327f0b73 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -179369,7 +179369,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -181253,7 +181253,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -183154,7 +183154,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index e75a5d670f7e..34614ca12c05 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -183544,7 +183544,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -185428,7 +185428,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -187329,7 +187329,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index 7d5645d6362e..01c1c260154e 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -187202,7 +187202,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -189121,7 +189121,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { @@ -191065,7 +191065,7 @@ { "name": "has", "in": "query", - "description": "

Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple has filters can be chained to check if multiple properties are present.

", + "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", "schema": { "oneOf": [ { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 7115f6f9dbf1..146985f66f09 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424" + "sha": "1c22f3361af92533fad97262cf4b7c18574f22a6" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 0a1f08e17263..d0adbf7c42f2 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424" + "sha": "1c22f3361af92533fad97262cf4b7c18574f22a6" } \ No newline at end of file From 2b993288dee89b889037a729a02c0b8769c4f45c Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 30 Apr 2025 00:32:47 -0700 Subject: [PATCH 2/2] GraphQL schema update (#55444) Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com> Co-authored-by: Kevin Heis Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/graphql/data/fpt/changelog.json | 14 ++++++++++++++ src/graphql/data/fpt/schema.docs.graphql | 9 +++++---- src/graphql/data/fpt/schema.json | 8 ++++---- src/graphql/data/ghec/schema.docs.graphql | 9 +++++---- src/graphql/data/ghec/schema.json | 8 ++++---- 5 files changed, 32 insertions(+), 16 deletions(-) diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 596d8908055a..33524822d18c 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,18 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Input field DraftPullRequestReviewThread.line changed type from Int! to Int

", + "

Input field DraftPullRequestReviewThread.path changed type from String! to String

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-04-29" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index fa75d7e716c5..aee077f9afbf 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -13049,14 +13049,15 @@ input DraftPullRequestReviewThread { body: String! """ - The line of the blob to which the thread refers. The end of the line range for multi-line comments. + The line of the blob to which the thread refers. The end of the line range for + multi-line comments. Required if not using positioning. """ - line: Int! + line: Int """ - Path to the file being commented on. + Path to the file being commented on. Required if not using positioning. """ - path: String! + path: String """ The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 1a08b234493f..f039fb8d9197 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -102376,16 +102376,16 @@ }, { "name": "line", - "description": "

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

", - "type": "Int!", + "description": "

The line of the blob to which the thread refers. The end of the line range for\nmulti-line comments. Required if not using positioning.

", + "type": "Int", "id": "int", "kind": "scalars", "href": "/graphql/reference/scalars#int" }, { "name": "path", - "description": "

Path to the file being commented on.

", - "type": "String!", + "description": "

Path to the file being commented on. Required if not using positioning.

", + "type": "String", "id": "string", "kind": "scalars", "href": "/graphql/reference/scalars#string" diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index fa75d7e716c5..aee077f9afbf 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -13049,14 +13049,15 @@ input DraftPullRequestReviewThread { body: String! """ - The line of the blob to which the thread refers. The end of the line range for multi-line comments. + The line of the blob to which the thread refers. The end of the line range for + multi-line comments. Required if not using positioning. """ - line: Int! + line: Int """ - Path to the file being commented on. + Path to the file being commented on. Required if not using positioning. """ - path: String! + path: String """ The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 1a08b234493f..f039fb8d9197 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -102376,16 +102376,16 @@ }, { "name": "line", - "description": "

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

", - "type": "Int!", + "description": "

The line of the blob to which the thread refers. The end of the line range for\nmulti-line comments. Required if not using positioning.

", + "type": "Int", "id": "int", "kind": "scalars", "href": "/graphql/reference/scalars#int" }, { "name": "path", - "description": "

Path to the file being commented on.

", - "type": "String!", + "description": "

Path to the file being commented on. Required if not using positioning.

", + "type": "String", "id": "string", "kind": "scalars", "href": "/graphql/reference/scalars#string"