From 9f343a87acc4c96106688a99c2e85b9f8be01dcd Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Fri, 17 Mar 2023 10:12:04 -0700 Subject: [PATCH] Update OpenAPI Description (#35662) Co-authored-by: Matt Pollard --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 56 +++++++++++++++++++++-- src/rest/data/ghae/schema.json | 8 ++-- src/rest/data/ghec-2022-11-28/schema.json | 56 +++++++++++++++++++++-- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 13 ++++++ src/webhooks/data/ghec/schema.json | 13 ++++++ src/webhooks/lib/config.json | 2 +- 8 files changed, 140 insertions(+), 12 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index fb184aeec4..7e28a70e0b 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "1efd1b509089086bc940ff34071f6b084945ead4" + "sha": "aaccfaf7077f9076e5ed45780e2e870f5451db31" } \ 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 52db433c4b..4a5a956a35 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -365211,6 +365211,10 @@ "httpStatusCode": "200", "description": "

OK

" }, + { + "httpStatusCode": "400", + "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" + }, { "httpStatusCode": "401", "description": "

Requires authentication

" @@ -367289,6 +367293,24 @@ "internal" ] } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "bodyParameters": [], @@ -368428,6 +368450,10 @@ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "400", + "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" } ] }, @@ -370513,6 +370539,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "bodyParameters": [], @@ -371656,6 +371700,10 @@ "httpStatusCode": "200", "description": "

OK

" }, + { + "httpStatusCode": "400", + "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" + }, { "httpStatusCode": "401", "description": "

Requires authentication

" @@ -473309,7 +473357,8 @@ }, { "name": "sort", - "description": "

Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

", + "deprecated": true, + "description": "

Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server). Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

", "in": "query", "required": false, "schema": { @@ -473321,8 +473370,9 @@ }, { "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", + "description": "

Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server). Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", "in": "query", + "deprecated": true, "required": false, "schema": { "type": "string", @@ -474365,7 +474415,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

Note: Starting on April 10, 2023, code search on GitHub.com will have a separate\nrate limit from other search types, of 10 requests per minute, and all code\nsearch requests will require authentication. For more information, see this blog post.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 57d4d66670..68484d8b59 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -358006,7 +358006,8 @@ }, { "name": "sort", - "description": "

Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: best match

", + "deprecated": true, + "description": "

Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server). Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: best match

", "in": "query", "required": false, "schema": { @@ -358018,8 +358019,9 @@ }, { "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", + "description": "

Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server). Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", "in": "query", + "deprecated": true, "required": false, "schema": { "type": "string", @@ -359018,7 +359020,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

Note: Starting on April 10, 2023, code search on GitHub.com will have a separate\nrate limit from other search types, of 10 requests per minute, and all code\nsearch requests will require authentication. For more information, see this blog post.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 2cd611ac2c..76ddb53100 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -381925,6 +381925,10 @@ "httpStatusCode": "200", "description": "

OK

" }, + { + "httpStatusCode": "400", + "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" + }, { "httpStatusCode": "401", "description": "

Requires authentication

" @@ -384003,6 +384007,24 @@ "internal" ] } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "bodyParameters": [], @@ -385142,6 +385164,10 @@ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "400", + "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" } ] }, @@ -387227,6 +387253,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "bodyParameters": [], @@ -388370,6 +388414,10 @@ "httpStatusCode": "200", "description": "

OK

" }, + { + "httpStatusCode": "400", + "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" + }, { "httpStatusCode": "401", "description": "

Requires authentication

" @@ -492473,7 +492521,8 @@ }, { "name": "sort", - "description": "

Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: best match

", + "deprecated": true, + "description": "

Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server). Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: best match

", "in": "query", "required": false, "schema": { @@ -492485,8 +492534,9 @@ }, { "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", + "description": "

Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server). Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", "in": "query", + "deprecated": true, "required": false, "schema": { "type": "string", @@ -493529,7 +493579,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

Note: Starting on April 10, 2023, code search on GitHub.com will have a separate\nrate limit from other search types, of 10 requests per minute, and all code\nsearch requests will require authentication. For more information, see this blog post.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index bfc18d5f8d..643d5ffcc6 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -20,5 +20,5 @@ "autogenerated": "rest", "allowTitleToDifferFromFilename": true }, - "sha": "1efd1b509089086bc940ff34071f6b084945ead4" + "sha": "aaccfaf7077f9076e5ed45780e2e870f5451db31" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 883fe014c3..f0d00eed3a 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -181528,6 +181528,19 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "make_latest", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "to", + "description": "

Whether this release was explicitly edited to be the latest.

", + "isRequired": true + } + ] } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index ea2fa770da..38d175287e 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -181528,6 +181528,19 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "make_latest", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "to", + "description": "

Whether this release was explicitly edited to be the latest.

", + "isRequired": true + } + ] } ] }, diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index fb184aeec4..7e28a70e0b 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "1efd1b509089086bc940ff34071f6b084945ead4" + "sha": "aaccfaf7077f9076e5ed45780e2e870f5451db31" } \ No newline at end of file