github
/
docs
зеркало из https://github.com/github/docs.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Update OpenAPI Descriptions (#30427) 

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
This commit is contained in:
github-openapi-bot 2022-09-01 04:03:10 -07:00 коммит произвёл GitHub
Родитель fde7aa1b0e
Коммит 89d9b73f11
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
12 изменённых файлов: 142 добавлений и 34 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

44
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": "<p>The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.</p>",
"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>",
"isRequired": true
},
{
"type": "string",
"name": "url_template",
"in": "body",
"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>",
"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>",
"isRequired": true
},
{
"type": "boolean",
"name": "is_alphanumeric",
"in": "body",
"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>",
"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=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"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"
]
}
}

10
lib/rest/static/decorated/ghes-3.3.json
Просмотреть файл

@ -402391,6 +402391,13 @@
"in": "body",
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
"isRequired": true
},
{
"type": "boolean",
"name": "is_alphanumeric",
"in": "body",
"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>",
"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=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
},
"parameters": {
"owner": "OWNER",

10
lib/rest/static/decorated/ghes-3.4.json
Просмотреть файл

@ -423478,6 +423478,13 @@
"in": "body",
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
"isRequired": true
},
{
"type": "boolean",
"name": "is_alphanumeric",
"in": "body",
"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>",
"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=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
},
"parameters": {
"owner": "OWNER",

10
lib/rest/static/decorated/ghes-3.5.json
Просмотреть файл

@ -433513,6 +433513,13 @@
"in": "body",
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
"isRequired": true
},
{
"type": "boolean",
"name": "is_alphanumeric",
"in": "body",
"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>",
"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=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
},
"parameters": {
"owner": "OWNER",

10
lib/rest/static/decorated/ghes-3.6.json
Просмотреть файл

@ -441900,6 +441900,13 @@
"in": "body",
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
"isRequired": true
},
{
"type": "boolean",
"name": "is_alphanumeric",
"in": "body",
"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>",
"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=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
},
"parameters": {
"owner": "OWNER",

10
lib/rest/static/decorated/github.ae.json
Просмотреть файл

@ -378752,6 +378752,13 @@
"in": "body",
"description": "<p>The URL must contain <code>&#x3C;num></code> for the reference number.</p>",
"isRequired": true
},
{
"type": "boolean",
"name": "is_alphanumeric",
"in": "body",
"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>",
"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=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
},
"parameters": {
"owner": "OWNER",

42
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 `<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`."
},
"is_alphanumeric": {
"type": "boolean",
"default": "true",
"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."
}
},
"required": [
@ -197722,7 +197731,8 @@
"default": {
"value": {
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"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": {

8
lib/rest/static/dereferenced/ghes-3.3.deref.json
Просмотреть файл

@ -161303,6 +161303,11 @@
"url_template": {
"type": "string",
"description": "The URL must contain `<num>` for the reference number."
},
"is_alphanumeric": {
"type": "boolean",
"default": "true",
"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."
}
},
"required": [
@ -161314,7 +161319,8 @@
"default": {
"value": {
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}
}
}

8
lib/rest/static/dereferenced/ghes-3.4.deref.json
Просмотреть файл

@ -172455,6 +172455,11 @@
"url_template": {
"type": "string",
"description": "The URL must contain `<num>` for the reference number."
},
"is_alphanumeric": {
"type": "boolean",
"default": "true",
"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."
}
},
"required": [
@ -172466,7 +172471,8 @@
"default": {
"value": {
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}
}
}

8
lib/rest/static/dereferenced/ghes-3.5.deref.json
Просмотреть файл

@ -182348,6 +182348,11 @@
"url_template": {
"type": "string",
"description": "The URL must contain `<num>` for the reference number."
},
"is_alphanumeric": {
"type": "boolean",
"default": "true",
"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."
}
},
"required": [
@ -182359,7 +182364,8 @@
"default": {
"value": {
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}
}
}

8
lib/rest/static/dereferenced/ghes-3.6.deref.json
Просмотреть файл

@ -186862,6 +186862,11 @@
"url_template": {
"type": "string",
"description": "The URL must contain `<num>` for the reference number."
},
"is_alphanumeric": {
"type": "boolean",
"default": "true",
"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."
}
},
"required": [
@ -186873,7 +186878,8 @@
"default": {
"value": {
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}
}
}

8
lib/rest/static/dereferenced/github.ae.deref.json
Просмотреть файл

@ -144215,6 +144215,11 @@
"url_template": {
"type": "string",
"description": "The URL must contain `<num>` for the reference number."
},
"is_alphanumeric": {
"type": "boolean",
"default": "true",
"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."
}
},
"required": [
@ -144226,7 +144231,8 @@
"default": {
"value": {
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>"
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}
}
}