From 89d9b73f11454bb1bcff1428f46ec91f84e6082a Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Thu, 1 Sep 2022 04:03:10 -0700 Subject: [PATCH] Update OpenAPI Descriptions (#30427) Co-authored-by: github-openapi-bot Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com> --- lib/rest/static/decorated/api.github.com.json | 44 ++++++++++++++----- lib/rest/static/decorated/ghes-3.3.json | 10 ++++- lib/rest/static/decorated/ghes-3.4.json | 10 ++++- lib/rest/static/decorated/ghes-3.5.json | 10 ++++- lib/rest/static/decorated/ghes-3.6.json | 10 ++++- lib/rest/static/decorated/github.ae.json | 10 ++++- .../dereferenced/api.github.com.deref.json | 42 +++++++++++++----- .../static/dereferenced/ghes-3.3.deref.json | 8 +++- .../static/dereferenced/ghes-3.4.deref.json | 8 +++- .../static/dereferenced/ghes-3.5.deref.json | 8 +++- .../static/dereferenced/ghes-3.6.deref.json | 8 +++- .../static/dereferenced/github.ae.deref.json | 8 +++- 12 files changed, 142 insertions(+), 34 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index eff66e74d9..aa7a3c81fc 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -513474,14 +513474,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } } @@ -513529,15 +513533,22 @@ "type": "string", "name": "key_prefix", "in": "body", - "description": "

The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.

", + "description": "

This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.

", "isRequired": true }, { "type": "string", "name": "url_template", "in": "body", - "description": "

The URL must contain <num> for the reference number. <num> matches alphanumeric characters A-Z (case insensitive), 0-9, and -.

", + "description": "

The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -513550,7 +513561,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -513593,14 +513605,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } } @@ -513705,14 +513721,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } } diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index d7407be305..c12e1ec107 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -402391,6 +402391,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -402403,7 +402410,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index dafeaa895b..62c325d1f7 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -423478,6 +423478,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -423490,7 +423497,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 4804c2185a..6be173891d 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -433513,6 +433513,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -433525,7 +433532,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index ce21f0d32d..50db10565f 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -441900,6 +441900,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -441912,7 +441919,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 1dee3d9d66..99faf888dc 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -378752,6 +378752,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -378764,7 +378771,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index b26aa13508..d083e84859 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -197632,14 +197632,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } }, @@ -197706,11 +197710,16 @@ "properties": { "key_prefix": { "type": "string", - "description": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit." + "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit." }, "url_template": { "type": "string", - "description": "The URL must contain `` for the reference number. `` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`." + "description": "The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -197722,7 +197731,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -197760,14 +197770,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] }, "examples": { @@ -197947,14 +197961,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] }, "examples": { diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 4046144335..89859d72b4 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -161303,6 +161303,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -161314,7 +161319,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index fd96e69e92..25d1ba27a0 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -172455,6 +172455,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -172466,7 +172471,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 0681d6560b..f6c7a09ed5 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -182348,6 +182348,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -182359,7 +182364,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index 312c316a95..1aee1e62fd 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -186862,6 +186862,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -186873,7 +186878,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index ce5b029ca7..6e8ef493b2 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -144215,6 +144215,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -144226,7 +144231,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } }