Skip to content

Commit 6103038

Browse files
mattpagemattpage
authored
Merge pull request #1492 from github/openapi-update-d2e537ef0be1a89f1d961a263caa73581ec811ce15a409e65a03c728b3d5be7d
Update OpenAPI 3.0 Descriptions
2 parents 46a49d9 + d72ae58 commit 6103038

24 files changed

+227
-38
lines changed

‎descriptions/api.github.com/api.github.com.json

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22868,11 +22868,16 @@
2286822868
"properties": {
2286922869
"key_prefix": {
2287022870
"type": "string",
22871-
"description": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit."
22871+
"description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit."
2287222872
},
2287322873
"url_template": {
2287422874
"type": "string",
22875-
"description": "The URL must contain `<num>` for the reference number. `<num>` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`."
22875+
"description": "The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`."
22876+
},
22877+
"is_alphanumeric": {
22878+
"type": "boolean",
22879+
"default": "true",
22880+
"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."
2287622881
}
2287722882
},
2287822883
"required": [
@@ -22884,7 +22889,8 @@
2288422889
"default": {
2288522890
"value": {
2288622891
"key_prefix": "TICKET-",
22887-
"url_template": "https://example.com/TICKET?query=<num>"
22892+
"url_template": "https://example.com/TICKET?query=<num>",
22893+
"is_alphanumeric": true
2288822894
}
2288922895
}
2289022896
}
@@ -72113,14 +72119,16 @@
7211372119
"type": "string"
7211472120
},
7211572121
"is_alphanumeric": {
72116-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
72122+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
72123+
"example": true,
7211772124
"type": "boolean"
7211872125
}
7211972126
},
7212072127
"required": [
7212172128
"id",
7212272129
"key_prefix",
72123-
"url_template"
72130+
"url_template",
72131+
"is_alphanumeric"
7212472132
]
7212572133
},
7212672134
"protected-branch-required-status-check": {

‎descriptions/api.github.com/api.github.com.yaml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16328,14 +16328,21 @@ paths:
1632816328
properties:
1632916329
key_prefix:
1633016330
type: string
16331-
description: The prefix appended by alphanumeric characters will
16332-
generate a link any time it is found in an issue, pull request,
16333-
or commit.
16331+
description: This prefix appended by certain characters will generate
16332+
a link any time it is found in an issue, pull request, or commit.
1633416333
url_template:
1633516334
type: string
1633616335
description: The URL must contain `<num>` for the reference number.
16337-
`<num>` matches alphanumeric characters `A-Z` (case insensitive),
16338-
`0-9`, and `-`.
16336+
`<num>` matches different characters depending on the value of
16337+
`is_alphanumeric`.
16338+
is_alphanumeric:
16339+
type: boolean
16340+
default: 'true'
16341+
description: Whether this autolink reference matches alphanumeric
16342+
characters. If true, the `<num>` parameter of the `url_template`
16343+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
16344+
and `-`. If false, this autolink reference only matches numeric
16345+
characters.
1633916346
required:
1634016347
- key_prefix
1634116348
- url_template
@@ -16344,6 +16351,7 @@ paths:
1634416351
value:
1634516352
key_prefix: TICKET-
1634616353
url_template: https://example.com/TICKET?query=<num>
16354+
is_alphanumeric: true
1634716355
responses:
1634816356
'201':
1634916357
description: response
@@ -52765,13 +52773,14 @@ components:
5276552773
type: string
5276652774
is_alphanumeric:
5276752775
description: Whether this autolink reference matches alphanumeric characters.
52768-
If false, this autolink reference is a legacy autolink that only matches
52769-
numeric characters.
52776+
If false, this autolink reference only matches numeric characters.
52777+
example: true
5277052778
type: boolean
5277152779
required:
5277252780
- id
5277352781
- key_prefix
5277452782
- url_template
52783+
- is_alphanumeric
5277552784
protected-branch-required-status-check:
5277652785
title: Protected Branch Required Status Check
5277752786
description: Protected Branch Required Status Check

‎descriptions/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -168084,14 +168084,16 @@
168084168084
"type": "string"
168085168085
},
168086168086
"is_alphanumeric": {
168087-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
168087+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
168088+
"example": true,
168088168089
"type": "boolean"
168089168090
}
168090168091
},
168091168092
"required": [
168092168093
"id",
168093168094
"key_prefix",
168094-
"url_template"
168095+
"url_template",
168096+
"is_alphanumeric"
168095168097
]
168096168098
}
168097168099
},
@@ -168158,11 +168160,16 @@
168158168160
"properties": {
168159168161
"key_prefix": {
168160168162
"type": "string",
168161-
"description": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit."
168163+
"description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit."
168162168164
},
168163168165
"url_template": {
168164168166
"type": "string",
168165-
"description": "The URL must contain `<num>` for the reference number. `<num>` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`."
168167+
"description": "The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`."
168168+
},
168169+
"is_alphanumeric": {
168170+
"type": "boolean",
168171+
"default": "true",
168172+
"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."
168166168173
}
168167168174
},
168168168175
"required": [
@@ -168174,7 +168181,8 @@
168174168181
"default": {
168175168182
"value": {
168176168183
"key_prefix": "TICKET-",
168177-
"url_template": "https://example.com/TICKET?query=<num>"
168184+
"url_template": "https://example.com/TICKET?query=<num>",
168185+
"is_alphanumeric": true
168178168186
}
168179168187
}
168180168188
}
@@ -168206,14 +168214,16 @@
168206168214
"type": "string"
168207168215
},
168208168216
"is_alphanumeric": {
168209-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
168217+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
168218+
"example": true,
168210168219
"type": "boolean"
168211168220
}
168212168221
},
168213168222
"required": [
168214168223
"id",
168215168224
"key_prefix",
168216-
"url_template"
168225+
"url_template",
168226+
"is_alphanumeric"
168217168227
]
168218168228
},
168219168229
"examples": {
@@ -168381,14 +168391,16 @@
168381168391
"type": "string"
168382168392
},
168383168393
"is_alphanumeric": {
168384-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
168394+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
168395+
"example": true,
168385168396
"type": "boolean"
168386168397
}
168387168398
},
168388168399
"required": [
168389168400
"id",
168390168401
"key_prefix",
168391-
"url_template"
168402+
"url_template",
168403+
"is_alphanumeric"
168392168404
]
168393168405
},
168394168406
"examples": {

‎descriptions/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35211,13 +35211,15 @@ paths:
3521135211
type: string
3521235212
is_alphanumeric:
3521335213
description: Whether this autolink reference matches alphanumeric
35214-
characters. If false, this autolink reference is a legacy
35215-
autolink that only matches numeric characters.
35214+
characters. If false, this autolink reference only matches
35215+
numeric characters.
35216+
example: true
3521635217
type: boolean
3521735218
required:
3521835219
- id
3521935220
- key_prefix
3522035221
- url_template
35222+
- is_alphanumeric
3522135223
examples:
3522235224
default:
3522335225
value:
@@ -35251,14 +35253,21 @@ paths:
3525135253
properties:
3525235254
key_prefix:
3525335255
type: string
35254-
description: The prefix appended by alphanumeric characters will
35255-
generate a link any time it is found in an issue, pull request,
35256-
or commit.
35256+
description: This prefix appended by certain characters will generate
35257+
a link any time it is found in an issue, pull request, or commit.
3525735258
url_template:
3525835259
type: string
3525935260
description: The URL must contain `<num>` for the reference number.
35260-
`<num>` matches alphanumeric characters `A-Z` (case insensitive),
35261-
`0-9`, and `-`.
35261+
`<num>` matches different characters depending on the value of
35262+
`is_alphanumeric`.
35263+
is_alphanumeric:
35264+
type: boolean
35265+
default: 'true'
35266+
description: Whether this autolink reference matches alphanumeric
35267+
characters. If true, the `<num>` parameter of the `url_template`
35268+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
35269+
and `-`. If false, this autolink reference only matches numeric
35270+
characters.
3526235271
required:
3526335272
- key_prefix
3526435273
- url_template
@@ -35267,6 +35276,7 @@ paths:
3526735276
value:
3526835277
key_prefix: TICKET-
3526935278
url_template: https://example.com/TICKET?query=<num>
35279+
is_alphanumeric: true
3527035280
responses:
3527135281
'201':
3527235282
description: response

‎descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137142,6 +137142,11 @@
137142137142
"url_template": {
137143137143
"type": "string",
137144137144
"description": "The URL must contain `<num>` for the reference number."
137145+
},
137146+
"is_alphanumeric": {
137147+
"type": "boolean",
137148+
"default": "true",
137149+
"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."
137145137150
}
137146137151
},
137147137152
"required": [
@@ -137153,7 +137158,8 @@
137153137158
"default": {
137154137159
"value": {
137155137160
"key_prefix": "TICKET-",
137156-
"url_template": "https://example.com/TICKET?query=<num>"
137161+
"url_template": "https://example.com/TICKET?query=<num>",
137162+
"is_alphanumeric": true
137157137163
}
137158137164
}
137159137165
}

‎descriptions/ghes-3.3/dereferenced/ghes-3.3.deref.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30096,6 +30096,14 @@ paths:
3009630096
url_template:
3009730097
type: string
3009830098
description: The URL must contain `<num>` for the reference number.
30099+
is_alphanumeric:
30100+
type: boolean
30101+
default: 'true'
30102+
description: Whether this autolink reference matches alphanumeric
30103+
characters. If true, the `<num>` parameter of the `url_template`
30104+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
30105+
and `-`. If false, this autolink reference only matches numeric
30106+
characters.
3009930107
required:
3010030108
- key_prefix
3010130109
- url_template
@@ -30104,6 +30112,7 @@ paths:
3010430112
value:
3010530113
key_prefix: TICKET-
3010630114
url_template: https://example.com/TICKET?query=<num>
30115+
is_alphanumeric: true
3010730116
responses:
3010830117
'201':
3010930118
description: response

‎descriptions/ghes-3.3/ghes-3.3.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20102,6 +20102,11 @@
2010220102
"url_template": {
2010320103
"type": "string",
2010420104
"description": "The URL must contain `<num>` for the reference number."
20105+
},
20106+
"is_alphanumeric": {
20107+
"type": "boolean",
20108+
"default": "true",
20109+
"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."
2010520110
}
2010620111
},
2010720112
"required": [
@@ -20113,7 +20118,8 @@
2011320118
"default": {
2011420119
"value": {
2011520120
"key_prefix": "TICKET-",
20116-
"url_template": "https://example.com/TICKET?query=<num>"
20121+
"url_template": "https://example.com/TICKET?query=<num>",
20122+
"is_alphanumeric": true
2011720123
}
2011820124
}
2011920125
}

‎descriptions/ghes-3.3/ghes-3.3.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14201,6 +14201,14 @@ paths:
1420114201
url_template:
1420214202
type: string
1420314203
description: The URL must contain `<num>` for the reference number.
14204+
is_alphanumeric:
14205+
type: boolean
14206+
default: 'true'
14207+
description: Whether this autolink reference matches alphanumeric
14208+
characters. If true, the `<num>` parameter of the `url_template`
14209+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
14210+
and `-`. If false, this autolink reference only matches numeric
14211+
characters.
1420414212
required:
1420514213
- key_prefix
1420614214
- url_template
@@ -14209,6 +14217,7 @@ paths:
1420914217
value:
1421014218
key_prefix: TICKET-
1421114219
url_template: https://example.com/TICKET?query=<num>
14220+
is_alphanumeric: true
1421214221
responses:
1421314222
'201':
1421414223
description: response

‎descriptions/ghes-3.4/dereferenced/ghes-3.4.deref.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146852,6 +146852,11 @@
146852146852
"url_template": {
146853146853
"type": "string",
146854146854
"description": "The URL must contain `<num>` for the reference number."
146855+
},
146856+
"is_alphanumeric": {
146857+
"type": "boolean",
146858+
"default": "true",
146859+
"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."
146855146860
}
146856146861
},
146857146862
"required": [
@@ -146863,7 +146868,8 @@
146863146868
"default": {
146864146869
"value": {
146865146870
"key_prefix": "TICKET-",
146866-
"url_template": "https://example.com/TICKET?query=<num>"
146871+
"url_template": "https://example.com/TICKET?query=<num>",
146872+
"is_alphanumeric": true
146867146873
}
146868146874
}
146869146875
}

0 commit comments

Comments
 (0)