Skip to content

Commit 89d9b73

Browse files
github-openapi-botguntrip
github-openapi-bot
and
guntrip
authored
Update OpenAPI Descriptions (github#30427)
Co-authored-by: github-openapi-bot <[email protected]> Co-authored-by: Steve Guntrip <[email protected]>
1 parent fde7aa1 commit 89d9b73

12 files changed

+142
-34
lines changed

‎lib/rest/static/decorated/api.github.com.json

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -513474,14 +513474,18 @@
513474513474
]
513475513475
},
513476513476
"is_alphanumeric": {
513477-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
513478-
"type": "boolean"
513477+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
513478+
"type": "boolean",
513479+
"examples": [
513480+
true
513481+
]
513479513482
}
513480513483
},
513481513484
"required": [
513482513485
"id",
513483513486
"key_prefix",
513484-
"url_template"
513487+
"url_template",
513488+
"is_alphanumeric"
513485513489
]
513486513490
}
513487513491
}
@@ -513529,15 +513533,22 @@
513529513533
"type": "string",
513530513534
"name": "key_prefix",
513531513535
"in": "body",
513532-
"description": "<p>The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.</p>",
513536+
"description": "<p>This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.</p>",
513533513537
"isRequired": true
513534513538
},
513535513539
{
513536513540
"type": "string",
513537513541
"name": "url_template",
513538513542
"in": "body",
513539-
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number. <code>&#x3C;num></code> matches alphanumeric characters <code>A-Z</code> (case insensitive), <code>0-9</code>, and <code>-</code>.</p>",
513543+
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number. <code>&#x3C;num></code> matches different characters depending on the value of <code>is_alphanumeric</code>.</p>",
513540513544
"isRequired": true
513545+
},
513546+
{
513547+
"type": "boolean",
513548+
"name": "is_alphanumeric",
513549+
"in": "body",
513550+
"description": "<p>Whether this autolink reference matches alphanumeric characters. If true, the <code>&#x3C;num></code> parameter of the <code>url_template</code> matches alphanumeric characters <code>A-Z</code> (case insensitive), <code>0-9</code>, and <code>-</code>. If false, this autolink reference only matches numeric characters.</p>",
513551+
"default": "true"
513541513552
}
513542513553
],
513543513554
"enabledForGitHubApps": true,
@@ -513550,7 +513561,8 @@
513550513561
"acceptHeader": "application/vnd.github.v3+json",
513551513562
"bodyParameters": {
513552513563
"key_prefix": "TICKET-",
513553-
"url_template": "https://example.com/TICKET?query=<num>"
513564+
"url_template": "https://example.com/TICKET?query=<num>",
513565+
"is_alphanumeric": true
513554513566
},
513555513567
"parameters": {
513556513568
"owner": "OWNER",
@@ -513593,14 +513605,18 @@
513593513605
]
513594513606
},
513595513607
"is_alphanumeric": {
513596-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
513597-
"type": "boolean"
513608+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
513609+
"type": "boolean",
513610+
"examples": [
513611+
true
513612+
]
513598513613
}
513599513614
},
513600513615
"required": [
513601513616
"id",
513602513617
"key_prefix",
513603-
"url_template"
513618+
"url_template",
513619+
"is_alphanumeric"
513604513620
]
513605513621
}
513606513622
}
@@ -513705,14 +513721,18 @@
513705513721
]
513706513722
},
513707513723
"is_alphanumeric": {
513708-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
513709-
"type": "boolean"
513724+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
513725+
"type": "boolean",
513726+
"examples": [
513727+
true
513728+
]
513710513729
}
513711513730
},
513712513731
"required": [
513713513732
"id",
513714513733
"key_prefix",
513715-
"url_template"
513734+
"url_template",
513735+
"is_alphanumeric"
513716513736
]
513717513737
}
513718513738
}

‎lib/rest/static/decorated/ghes-3.3.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402391,6 +402391,13 @@
402391402391
"in": "body",
402392402392
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
402393402393
"isRequired": true
402394+
},
402395+
{
402396+
"type": "boolean",
402397+
"name": "is_alphanumeric",
402398+
"in": "body",
402399+
"description": "<p>Whether this autolink reference matches alphanumeric characters. If true, the <code>&#x3C;num></code> parameter of the <code>url_template</code> matches alphanumeric characters <code>A-Z</code> (case insensitive), <code>0-9</code>, and <code>-</code>. If false, this autolink reference only matches numeric characters.</p>",
402400+
"default": "true"
402394402401
}
402395402402
],
402396402403
"enabledForGitHubApps": true,
@@ -402403,7 +402410,8 @@
402403402410
"acceptHeader": "application/vnd.github.v3+json",
402404402411
"bodyParameters": {
402405402412
"key_prefix": "TICKET-",
402406-
"url_template": "https://example.com/TICKET?query=<num>"
402413+
"url_template": "https://example.com/TICKET?query=<num>",
402414+
"is_alphanumeric": true
402407402415
},
402408402416
"parameters": {
402409402417
"owner": "OWNER",

‎lib/rest/static/decorated/ghes-3.4.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423478,6 +423478,13 @@
423478423478
"in": "body",
423479423479
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
423480423480
"isRequired": true
423481+
},
423482+
{
423483+
"type": "boolean",
423484+
"name": "is_alphanumeric",
423485+
"in": "body",
423486+
"description": "<p>Whether this autolink reference matches alphanumeric characters. If true, the <code>&#x3C;num></code> parameter of the <code>url_template</code> matches alphanumeric characters <code>A-Z</code> (case insensitive), <code>0-9</code>, and <code>-</code>. If false, this autolink reference only matches numeric characters.</p>",
423487+
"default": "true"
423481423488
}
423482423489
],
423483423490
"enabledForGitHubApps": true,
@@ -423490,7 +423497,8 @@
423490423497
"acceptHeader": "application/vnd.github.v3+json",
423491423498
"bodyParameters": {
423492423499
"key_prefix": "TICKET-",
423493-
"url_template": "https://example.com/TICKET?query=<num>"
423500+
"url_template": "https://example.com/TICKET?query=<num>",
423501+
"is_alphanumeric": true
423494423502
},
423495423503
"parameters": {
423496423504
"owner": "OWNER",

‎lib/rest/static/decorated/ghes-3.5.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433513,6 +433513,13 @@
433513433513
"in": "body",
433514433514
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
433515433515
"isRequired": true
433516+
},
433517+
{
433518+
"type": "boolean",
433519+
"name": "is_alphanumeric",
433520+
"in": "body",
433521+
"description": "<p>Whether this autolink reference matches alphanumeric characters. If true, the <code>&#x3C;num></code> parameter of the <code>url_template</code> matches alphanumeric characters <code>A-Z</code> (case insensitive), <code>0-9</code>, and <code>-</code>. If false, this autolink reference only matches numeric characters.</p>",
433522+
"default": "true"
433516433523
}
433517433524
],
433518433525
"enabledForGitHubApps": true,
@@ -433525,7 +433532,8 @@
433525433532
"acceptHeader": "application/vnd.github.v3+json",
433526433533
"bodyParameters": {
433527433534
"key_prefix": "TICKET-",
433528-
"url_template": "https://example.com/TICKET?query=<num>"
433535+
"url_template": "https://example.com/TICKET?query=<num>",
433536+
"is_alphanumeric": true
433529433537
},
433530433538
"parameters": {
433531433539
"owner": "OWNER",

‎lib/rest/static/decorated/ghes-3.6.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441900,6 +441900,13 @@
441900441900
"in": "body",
441901441901
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
441902441902
"isRequired": true
441903+
},
441904+
{
441905+
"type": "boolean",
441906+
"name": "is_alphanumeric",
441907+
"in": "body",
441908+
"description": "<p>Whether this autolink reference matches alphanumeric characters. If true, the <code>&#x3C;num></code> parameter of the <code>url_template</code> matches alphanumeric characters <code>A-Z</code> (case insensitive), <code>0-9</code>, and <code>-</code>. If false, this autolink reference only matches numeric characters.</p>",
441909+
"default": "true"
441903441910
}
441904441911
],
441905441912
"enabledForGitHubApps": true,
@@ -441912,7 +441919,8 @@
441912441919
"acceptHeader": "application/vnd.github.v3+json",
441913441920
"bodyParameters": {
441914441921
"key_prefix": "TICKET-",
441915-
"url_template": "https://example.com/TICKET?query=<num>"
441922+
"url_template": "https://example.com/TICKET?query=<num>",
441923+
"is_alphanumeric": true
441916441924
},
441917441925
"parameters": {
441918441926
"owner": "OWNER",

0 commit comments

Comments
 (0)