Skip to content

Commit 518b870

Browse files
author
Marc-Andre Giroux
authored
Merge pull request #482 from github/openapi-update-e231270d19182ffb6d171712ff1a170a84fc05988f65f77215e00ae2843858cc
Update OpenAPI Descriptions
2 parents dd0f775 + 713539f commit 518b870

36 files changed

+2401
-1185
lines changed

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

Lines changed: 289 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5822,7 +5822,7 @@
58225822
"parameters": [
58235823
{
58245824
"name": "filter",
5825-
"description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation",
5825+
"description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation",
58265826
"in": "query",
58275827
"required": false,
58285828
"schema": {
@@ -11107,7 +11107,7 @@
1110711107
},
1110811108
{
1110911109
"name": "filter",
11110-
"description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation",
11110+
"description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation",
1111111111
"in": "query",
1111211112
"required": false,
1111311113
"schema": {
@@ -20367,6 +20367,238 @@
2036720367
}
2036820368
}
2036920369
},
20370+
"/repos/{owner}/{repo}/autolinks": {
20371+
"get": {
20372+
"summary": "List all autolinks of a repository",
20373+
"description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
20374+
"tags": [
20375+
"repos"
20376+
],
20377+
"operationId": "repos/list-autolinks",
20378+
"externalDocs": {
20379+
"description": "API method documentation",
20380+
"url": "https://docs.github.com/v3/repos#list-autolinks"
20381+
},
20382+
"parameters": [
20383+
{
20384+
"$ref": "#/components/parameters/owner"
20385+
},
20386+
{
20387+
"$ref": "#/components/parameters/repo"
20388+
},
20389+
{
20390+
"$ref": "#/components/parameters/page"
20391+
}
20392+
],
20393+
"responses": {
20394+
"200": {
20395+
"description": "Response",
20396+
"content": {
20397+
"application/json": {
20398+
"schema": {
20399+
"type": "array",
20400+
"items": {
20401+
"$ref": "#/components/schemas/autolink"
20402+
}
20403+
},
20404+
"examples": {
20405+
"default": {
20406+
"$ref": "#/components/examples/autolink-items"
20407+
}
20408+
}
20409+
}
20410+
}
20411+
}
20412+
},
20413+
"x-github": {
20414+
"githubCloudOnly": false,
20415+
"enabledForGitHubApps": true,
20416+
"previews": [
20417+
20418+
],
20419+
"category": "repos",
20420+
"subcategory": "autolinks"
20421+
}
20422+
},
20423+
"post": {
20424+
"summary": "Create an autolink reference for a repository",
20425+
"description": "Users with admin access to the repository can create an autolink.",
20426+
"tags": [
20427+
"repos"
20428+
],
20429+
"operationId": "repos/create-autolink",
20430+
"externalDocs": {
20431+
"description": "API method documentation",
20432+
"url": "https://docs.github.com/v3/repos#create-an-autolink"
20433+
},
20434+
"parameters": [
20435+
{
20436+
"$ref": "#/components/parameters/owner"
20437+
},
20438+
{
20439+
"$ref": "#/components/parameters/repo"
20440+
}
20441+
],
20442+
"requestBody": {
20443+
"content": {
20444+
"application/json": {
20445+
"schema": {
20446+
"type": "object",
20447+
"properties": {
20448+
"key_prefix": {
20449+
"type": "string",
20450+
"description": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit."
20451+
},
20452+
"url_template": {
20453+
"type": "string",
20454+
"description": "The URL must contain <num> for the reference number."
20455+
}
20456+
},
20457+
"required": [
20458+
"key_prefix",
20459+
"url_template"
20460+
]
20461+
},
20462+
"example": {
20463+
"key_prefix": "TICKET-",
20464+
"url_template": "https://example.com/TICKET?query=<num>"
20465+
}
20466+
}
20467+
}
20468+
},
20469+
"responses": {
20470+
"201": {
20471+
"description": "response",
20472+
"content": {
20473+
"application/json": {
20474+
"schema": {
20475+
"$ref": "#/components/schemas/autolink"
20476+
},
20477+
"examples": {
20478+
"default": {
20479+
"$ref": "#/components/examples/autolink"
20480+
}
20481+
}
20482+
}
20483+
},
20484+
"headers": {
20485+
"Location": {
20486+
"example": "https://api.github.com/repos/octocat/Hello-World/autolinks/1",
20487+
"schema": {
20488+
"type": "string"
20489+
}
20490+
}
20491+
}
20492+
},
20493+
"422": {
20494+
"$ref": "#/components/responses/validation_failed"
20495+
}
20496+
},
20497+
"x-github": {
20498+
"githubCloudOnly": false,
20499+
"enabledForGitHubApps": true,
20500+
"previews": [
20501+
20502+
],
20503+
"category": "repos",
20504+
"subcategory": "autolinks"
20505+
}
20506+
}
20507+
},
20508+
"/repos/{owner}/{repo}/autolinks/{autolink_id}": {
20509+
"get": {
20510+
"summary": "Get an autolink reference of a repository",
20511+
"description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
20512+
"tags": [
20513+
"repos"
20514+
],
20515+
"operationId": "repos/get-autolink",
20516+
"externalDocs": {
20517+
"description": "API method documentation",
20518+
"url": "https://docs.github.com/v3/repos#get-autolink"
20519+
},
20520+
"parameters": [
20521+
{
20522+
"$ref": "#/components/parameters/owner"
20523+
},
20524+
{
20525+
"$ref": "#/components/parameters/repo"
20526+
},
20527+
{
20528+
"$ref": "#/components/parameters/autolink-id"
20529+
}
20530+
],
20531+
"responses": {
20532+
"200": {
20533+
"description": "Response",
20534+
"content": {
20535+
"application/json": {
20536+
"schema": {
20537+
"$ref": "#/components/schemas/autolink"
20538+
},
20539+
"examples": {
20540+
"default": {
20541+
"$ref": "#/components/examples/autolink"
20542+
}
20543+
}
20544+
}
20545+
}
20546+
},
20547+
"404": {
20548+
"$ref": "#/components/responses/not_found"
20549+
}
20550+
},
20551+
"x-github": {
20552+
"githubCloudOnly": false,
20553+
"enabledForGitHubApps": true,
20554+
"previews": [
20555+
20556+
],
20557+
"category": "repos",
20558+
"subcategory": "autolinks"
20559+
}
20560+
},
20561+
"delete": {
20562+
"summary": "Delete an autolink reference from a repository",
20563+
"description": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
20564+
"tags": [
20565+
"repos"
20566+
],
20567+
"operationId": "repos/delete-autolink",
20568+
"externalDocs": {
20569+
"description": "API method documentation",
20570+
"url": "https://docs.github.com/v3/repos#delete-autolink"
20571+
},
20572+
"parameters": [
20573+
{
20574+
"$ref": "#/components/parameters/owner"
20575+
},
20576+
{
20577+
"$ref": "#/components/parameters/repo"
20578+
},
20579+
{
20580+
"$ref": "#/components/parameters/autolink-id"
20581+
}
20582+
],
20583+
"responses": {
20584+
"204": {
20585+
"description": "Response"
20586+
},
20587+
"404": {
20588+
"$ref": "#/components/responses/not_found"
20589+
}
20590+
},
20591+
"x-github": {
20592+
"githubCloudOnly": false,
20593+
"enabledForGitHubApps": true,
20594+
"previews": [
20595+
20596+
],
20597+
"category": "repos",
20598+
"subcategory": "autolinks"
20599+
}
20600+
}
20601+
},
2037020602
"/repos/{owner}/{repo}/automated-security-fixes": {
2037120603
"put": {
2037220604
"summary": "Enable automated security fixes",
@@ -48186,7 +48418,7 @@
4818648418
"parameters": [
4818748419
{
4818848420
"name": "filter",
48189-
"description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation",
48421+
"description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation",
4819048422
"in": "query",
4819148423
"required": false,
4819248424
"schema": {
@@ -61987,6 +62219,32 @@
6198762219
"billable"
6198862220
]
6198962221
},
62222+
"autolink": {
62223+
"title": "Autolink reference",
62224+
"description": "An autolink reference.",
62225+
"type": "object",
62226+
"properties": {
62227+
"id": {
62228+
"type": "integer",
62229+
"example": 3
62230+
},
62231+
"key_prefix": {
62232+
"description": "The prefix of a key that is linkified.",
62233+
"example": "TICKET-",
62234+
"type": "string"
62235+
},
62236+
"url_template": {
62237+
"description": "A template for the target URL that is generated if a key was found.",
62238+
"example": "https://example.com/TICKET?query=<num>",
62239+
"type": "string"
62240+
}
62241+
},
62242+
"required": [
62243+
"id",
62244+
"key_prefix",
62245+
"url_template"
62246+
]
62247+
},
6199062248
"protected-branch-admin-enforced": {
6199162249
"title": "Protected Branch Admin Enforced",
6199262250
"description": "Protected Branch Admin Enforced",
@@ -71628,6 +71886,9 @@
7162871886
"body_text": {
7162971887
"type": "string"
7163071888
},
71889+
"mentions_count": {
71890+
"type": "integer"
71891+
},
7163171892
"discussion_url": {
7163271893
"description": "The URL of the release discussion.",
7163371894
"type": "string",
@@ -82090,6 +82351,22 @@
8209082351
}
8209182352
}
8209282353
},
82354+
"autolink-items": {
82355+
"value": [
82356+
{
82357+
"id": 1,
82358+
"key_prefix": "TICKET-",
82359+
"url_template": "https://example.com/TICKET?query=<num>"
82360+
}
82361+
]
82362+
},
82363+
"autolink": {
82364+
"value": {
82365+
"id": 1,
82366+
"key_prefix": "TICKET-",
82367+
"url_template": "https://example.com/TICKET?query=<num>"
82368+
}
82369+
},
8209382370
"short-branch-with-protection-items": {
8209482371
"value": [
8209582372
{
@@ -95100,6 +95377,15 @@
9510095377
]
9510195378
}
9510295379
},
95380+
"autolink-id": {
95381+
"name": "autolink_id",
95382+
"description": "autolink_id parameter",
95383+
"in": "path",
95384+
"required": true,
95385+
"schema": {
95386+
"type": "integer"
95387+
}
95388+
},
9510395389
"branch": {
9510495390
"name": "branch",
9510595391
"description": "The name of the branch.",

0 commit comments

Comments
 (0)