Skip to content

Commit 46a49d9

Browse files
mattpagemattpage
authored
Merge pull request #1493 from github/openapi-update-2ce3e6e665bce9af987d8ec1edae0187208dbd8272999f249823e8f38e8f52b7
Update OpenAPI 3.1 Descriptions
2 parents 2bc8e22 + f598065 commit 46a49d9

24 files changed

Lines changed: 241 additions & 42 deletions

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

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22994,11 +22994,16 @@
2299422994
"properties": {
2299522995
"key_prefix": {
2299622996
"type": "string",
22997-
"description": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit."
22997+
"description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit."
2299822998
},
2299922999
"url_template": {
2300023000
"type": "string",
23001-
"description": "The URL must contain `<num>` for the reference number. `<num>` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`."
23001+
"description": "The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`."
23002+
},
23003+
"is_alphanumeric": {
23004+
"type": "boolean",
23005+
"default": "true",
23006+
"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."
2300223007
}
2300323008
},
2300423009
"required": [
@@ -23010,7 +23015,8 @@
2301023015
"default": {
2301123016
"value": {
2301223017
"key_prefix": "TICKET-",
23013-
"url_template": "https://example.com/TICKET?query=<num>"
23018+
"url_template": "https://example.com/TICKET?query=<num>",
23019+
"is_alphanumeric": true
2301423020
}
2301523021
}
2301623022
}
@@ -73376,14 +73382,18 @@
7337673382
]
7337773383
},
7337873384
"is_alphanumeric": {
73379-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
73380-
"type": "boolean"
73385+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
73386+
"type": "boolean",
73387+
"examples": [
73388+
true
73389+
]
7338173390
}
7338273391
},
7338373392
"required": [
7338473393
"id",
7338573394
"key_prefix",
73386-
"url_template"
73395+
"url_template",
73396+
"is_alphanumeric"
7338773397
]
7338873398
},
7338973399
"protected-branch-required-status-check": {

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

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16388,14 +16388,21 @@ paths:
1638816388
properties:
1638916389
key_prefix:
1639016390
type: string
16391-
description: The prefix appended by alphanumeric characters will
16392-
generate a link any time it is found in an issue, pull request,
16393-
or commit.
16391+
description: This prefix appended by certain characters will generate
16392+
a link any time it is found in an issue, pull request, or commit.
1639416393
url_template:
1639516394
type: string
1639616395
description: The URL must contain `<num>` for the reference number.
16397-
`<num>` matches alphanumeric characters `A-Z` (case insensitive),
16398-
`0-9`, and `-`.
16396+
`<num>` matches different characters depending on the value of
16397+
`is_alphanumeric`.
16398+
is_alphanumeric:
16399+
type: boolean
16400+
default: 'true'
16401+
description: Whether this autolink reference matches alphanumeric
16402+
characters. If true, the `<num>` parameter of the `url_template`
16403+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
16404+
and `-`. If false, this autolink reference only matches numeric
16405+
characters.
1639916406
required:
1640016407
- key_prefix
1640116408
- url_template
@@ -16404,6 +16411,7 @@ paths:
1640416411
value:
1640516412
key_prefix: TICKET-
1640616413
url_template: https://example.com/TICKET?query=<num>
16414+
is_alphanumeric: true
1640716415
responses:
1640816416
'201':
1640916417
description: response
@@ -52829,13 +52837,15 @@ components:
5282952837
- https://example.com/TICKET?query=<num>
5283052838
is_alphanumeric:
5283152839
description: Whether this autolink reference matches alphanumeric characters.
52832-
If false, this autolink reference is a legacy autolink that only matches
52833-
numeric characters.
52840+
If false, this autolink reference only matches numeric characters.
5283452841
type: boolean
52842+
examples:
52843+
- true
5283552844
required:
5283652845
- id
5283752846
- key_prefix
5283852847
- url_template
52848+
- is_alphanumeric
5283952849
protected-branch-required-status-check:
5284052850
title: Protected Branch Required Status Check
5284152851
description: Protected Branch Required Status Check

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

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -197632,14 +197632,18 @@
197632197632
]
197633197633
},
197634197634
"is_alphanumeric": {
197635-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
197636-
"type": "boolean"
197635+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
197636+
"type": "boolean",
197637+
"examples": [
197638+
true
197639+
]
197637197640
}
197638197641
},
197639197642
"required": [
197640197643
"id",
197641197644
"key_prefix",
197642-
"url_template"
197645+
"url_template",
197646+
"is_alphanumeric"
197643197647
]
197644197648
}
197645197649
},
@@ -197706,11 +197710,16 @@
197706197710
"properties": {
197707197711
"key_prefix": {
197708197712
"type": "string",
197709-
"description": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit."
197713+
"description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit."
197710197714
},
197711197715
"url_template": {
197712197716
"type": "string",
197713-
"description": "The URL must contain `<num>` for the reference number. `<num>` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`."
197717+
"description": "The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`."
197718+
},
197719+
"is_alphanumeric": {
197720+
"type": "boolean",
197721+
"default": "true",
197722+
"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."
197714197723
}
197715197724
},
197716197725
"required": [
@@ -197722,7 +197731,8 @@
197722197731
"default": {
197723197732
"value": {
197724197733
"key_prefix": "TICKET-",
197725-
"url_template": "https://example.com/TICKET?query=<num>"
197734+
"url_template": "https://example.com/TICKET?query=<num>",
197735+
"is_alphanumeric": true
197726197736
}
197727197737
}
197728197738
}
@@ -197760,14 +197770,18 @@
197760197770
]
197761197771
},
197762197772
"is_alphanumeric": {
197763-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
197764-
"type": "boolean"
197773+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
197774+
"type": "boolean",
197775+
"examples": [
197776+
true
197777+
]
197765197778
}
197766197779
},
197767197780
"required": [
197768197781
"id",
197769197782
"key_prefix",
197770-
"url_template"
197783+
"url_template",
197784+
"is_alphanumeric"
197771197785
]
197772197786
},
197773197787
"examples": {
@@ -197947,14 +197961,18 @@
197947197961
]
197948197962
},
197949197963
"is_alphanumeric": {
197950-
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.",
197951-
"type": "boolean"
197964+
"description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
197965+
"type": "boolean",
197966+
"examples": [
197967+
true
197968+
]
197952197969
}
197953197970
},
197954197971
"required": [
197955197972
"id",
197956197973
"key_prefix",
197957-
"url_template"
197974+
"url_template",
197975+
"is_alphanumeric"
197958197976
]
197959197977
},
197960197978
"examples": {

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

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36290,13 +36290,16 @@ paths:
3629036290
- https://example.com/TICKET?query=<num>
3629136291
is_alphanumeric:
3629236292
description: Whether this autolink reference matches alphanumeric
36293-
characters. If false, this autolink reference is a legacy
36294-
autolink that only matches numeric characters.
36293+
characters. If false, this autolink reference only matches
36294+
numeric characters.
3629536295
type: boolean
36296+
examples:
36297+
- true
3629636298
required:
3629736299
- id
3629836300
- key_prefix
3629936301
- url_template
36302+
- is_alphanumeric
3630036303
examples:
3630136304
default:
3630236305
value:
@@ -36330,14 +36333,21 @@ paths:
3633036333
properties:
3633136334
key_prefix:
3633236335
type: string
36333-
description: The prefix appended by alphanumeric characters will
36334-
generate a link any time it is found in an issue, pull request,
36335-
or commit.
36336+
description: This prefix appended by certain characters will generate
36337+
a link any time it is found in an issue, pull request, or commit.
3633636338
url_template:
3633736339
type: string
3633836340
description: The URL must contain `<num>` for the reference number.
36339-
`<num>` matches alphanumeric characters `A-Z` (case insensitive),
36340-
`0-9`, and `-`.
36341+
`<num>` matches different characters depending on the value of
36342+
`is_alphanumeric`.
36343+
is_alphanumeric:
36344+
type: boolean
36345+
default: 'true'
36346+
description: Whether this autolink reference matches alphanumeric
36347+
characters. If true, the `<num>` parameter of the `url_template`
36348+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
36349+
and `-`. If false, this autolink reference only matches numeric
36350+
characters.
3634136351
required:
3634236352
- key_prefix
3634336353
- url_template
@@ -36346,6 +36356,7 @@ paths:
3634636356
value:
3634736357
key_prefix: TICKET-
3634836358
url_template: https://example.com/TICKET?query=<num>
36359+
is_alphanumeric: true
3634936360
responses:
3635036361
'201':
3635136362
description: response

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161303,6 +161303,11 @@
161303161303
"url_template": {
161304161304
"type": "string",
161305161305
"description": "The URL must contain `<num>` for the reference number."
161306+
},
161307+
"is_alphanumeric": {
161308+
"type": "boolean",
161309+
"default": "true",
161310+
"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."
161306161311
}
161307161312
},
161308161313
"required": [
@@ -161314,7 +161319,8 @@
161314161319
"default": {
161315161320
"value": {
161316161321
"key_prefix": "TICKET-",
161317-
"url_template": "https://example.com/TICKET?query=<num>"
161322+
"url_template": "https://example.com/TICKET?query=<num>",
161323+
"is_alphanumeric": true
161318161324
}
161319161325
}
161320161326
}

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31052,6 +31052,14 @@ paths:
3105231052
url_template:
3105331053
type: string
3105431054
description: The URL must contain `<num>` for the reference number.
31055+
is_alphanumeric:
31056+
type: boolean
31057+
default: 'true'
31058+
description: Whether this autolink reference matches alphanumeric
31059+
characters. If true, the `<num>` parameter of the `url_template`
31060+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
31061+
and `-`. If false, this autolink reference only matches numeric
31062+
characters.
3105531063
required:
3105631064
- key_prefix
3105731065
- url_template
@@ -31060,6 +31068,7 @@ paths:
3106031068
value:
3106131069
key_prefix: TICKET-
3106231070
url_template: https://example.com/TICKET?query=<num>
31071+
is_alphanumeric: true
3106331072
responses:
3106431073
'201':
3106531074
description: response

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20221,6 +20221,11 @@
2022120221
"url_template": {
2022220222
"type": "string",
2022320223
"description": "The URL must contain `<num>` for the reference number."
20224+
},
20225+
"is_alphanumeric": {
20226+
"type": "boolean",
20227+
"default": "true",
20228+
"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."
2022420229
}
2022520230
},
2022620231
"required": [
@@ -20232,7 +20237,8 @@
2023220237
"default": {
2023320238
"value": {
2023420239
"key_prefix": "TICKET-",
20235-
"url_template": "https://example.com/TICKET?query=<num>"
20240+
"url_template": "https://example.com/TICKET?query=<num>",
20241+
"is_alphanumeric": true
2023620242
}
2023720243
}
2023820244
}

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14256,6 +14256,14 @@ paths:
1425614256
url_template:
1425714257
type: string
1425814258
description: The URL must contain `<num>` for the reference number.
14259+
is_alphanumeric:
14260+
type: boolean
14261+
default: 'true'
14262+
description: Whether this autolink reference matches alphanumeric
14263+
characters. If true, the `<num>` parameter of the `url_template`
14264+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
14265+
and `-`. If false, this autolink reference only matches numeric
14266+
characters.
1425914267
required:
1426014268
- key_prefix
1426114269
- url_template
@@ -14264,6 +14272,7 @@ paths:
1426414272
value:
1426514273
key_prefix: TICKET-
1426614274
url_template: https://example.com/TICKET?query=<num>
14275+
is_alphanumeric: true
1426714276
responses:
1426814277
'201':
1426914278
description: response

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172455,6 +172455,11 @@
172455172455
"url_template": {
172456172456
"type": "string",
172457172457
"description": "The URL must contain `<num>` for the reference number."
172458+
},
172459+
"is_alphanumeric": {
172460+
"type": "boolean",
172461+
"default": "true",
172462+
"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."
172458172463
}
172459172464
},
172460172465
"required": [
@@ -172466,7 +172471,8 @@
172466172471
"default": {
172467172472
"value": {
172468172473
"key_prefix": "TICKET-",
172469-
"url_template": "https://example.com/TICKET?query=<num>"
172474+
"url_template": "https://example.com/TICKET?query=<num>",
172475+
"is_alphanumeric": true
172470172476
}
172471172477
}
172472172478
}

‎descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33032,6 +33032,14 @@ paths:
3303233032
url_template:
3303333033
type: string
3303433034
description: The URL must contain `<num>` for the reference number.
33035+
is_alphanumeric:
33036+
type: boolean
33037+
default: 'true'
33038+
description: Whether this autolink reference matches alphanumeric
33039+
characters. If true, the `<num>` parameter of the `url_template`
33040+
matches alphanumeric characters `A-Z` (case insensitive), `0-9`,
33041+
and `-`. If false, this autolink reference only matches numeric
33042+
characters.
3303533043
required:
3303633044
- key_prefix
3303733045
- url_template
@@ -33040,6 +33048,7 @@ paths:
3304033048
value:
3304133049
key_prefix: TICKET-
3304233050
url_template: https://example.com/TICKET?query=<num>
33051+
is_alphanumeric: true
3304333052
responses:
3304433053
'201':
3304533054
description: response

0 commit comments

Comments
 (0)