Skip to content

Commit bc5ca32

Browse files
authored
Merge pull request #3364 from github/openapi-update-da8d4acbe8f92ab0f53b65b1b558fc55022af249ef089d8415b613310a6cacdc
Update OpenAPI 3.0 Descriptions
2 parents 4697ca5 + 2afb874 commit bc5ca32

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+330
-312
lines changed

descriptions/api.github.com/api.github.com.2022-11-28.json

+21-6
Original file line numberDiff line numberDiff line change
@@ -25569,25 +25569,22 @@
2556925569
},
2557025570
"/repos/{owner}/{repo}/autolinks": {
2557125571
"get": {
25572-
"summary": "List all autolinks of a repository",
25573-
"description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
25572+
"summary": "Get all autolinks of a repository",
25573+
"description": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.",
2557425574
"tags": [
2557525575
"repos"
2557625576
],
2557725577
"operationId": "repos/list-autolinks",
2557825578
"externalDocs": {
2557925579
"description": "API method documentation",
25580-
"url": "https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository"
25580+
"url": "https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository"
2558125581
},
2558225582
"parameters": [
2558325583
{
2558425584
"$ref": "#/components/parameters/owner"
2558525585
},
2558625586
{
2558725587
"$ref": "#/components/parameters/repo"
25588-
},
25589-
{
25590-
"$ref": "#/components/parameters/page"
2559125588
}
2559225589
],
2559325590
"responses": {
@@ -98809,6 +98806,24 @@
9880998806
}
9881098807
}
9881198808
},
98809+
"repository-rule-params-restricted-commits": {
98810+
"title": "RestrictedCommits",
98811+
"description": "Restricted commit",
98812+
"type": "object",
98813+
"properties": {
98814+
"oid": {
98815+
"type": "string",
98816+
"description": "Full or abbreviated commit hash to reject"
98817+
},
98818+
"reason": {
98819+
"type": "string",
98820+
"description": "Reason for restriction"
98821+
}
98822+
},
98823+
"required": [
98824+
"oid"
98825+
]
98826+
},
9881298827
"repository-rule-params-workflow-file-reference": {
9881398828
"title": "WorkflowFileReference",
9881498829
"description": "A workflow that must run for this rule to pass",

descriptions/api.github.com/api.github.com.2022-11-28.yaml

+16-4
Original file line numberDiff line numberDiff line change
@@ -18310,21 +18310,20 @@ paths:
1831018310
subcategory: assignees
1831118311
"/repos/{owner}/{repo}/autolinks":
1831218312
get:
18313-
summary: List all autolinks of a repository
18313+
summary: Get all autolinks of a repository
1831418314
description: |-
18315-
This returns a list of autolinks configured for the given repository.
18315+
Gets all autolinks that are configured for a repository.
1831618316

1831718317
Information about autolinks are only available to repository administrators.
1831818318
tags:
1831918319
- repos
1832018320
operationId: repos/list-autolinks
1832118321
externalDocs:
1832218322
description: API method documentation
18323-
url: https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository
18323+
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
1832418324
parameters:
1832518325
- "$ref": "#/components/parameters/owner"
1832618326
- "$ref": "#/components/parameters/repo"
18327-
- "$ref": "#/components/parameters/page"
1832818327
responses:
1832918328
'200':
1833018329
description: Response
@@ -72010,6 +72009,19 @@ components:
7201072009
required:
7201172010
- operator
7201272011
- pattern
72012+
repository-rule-params-restricted-commits:
72013+
title: RestrictedCommits
72014+
description: Restricted commit
72015+
type: object
72016+
properties:
72017+
oid:
72018+
type: string
72019+
description: Full or abbreviated commit hash to reject
72020+
reason:
72021+
type: string
72022+
description: Reason for restriction
72023+
required:
72024+
- oid
7201372025
repository-rule-params-workflow-file-reference:
7201472026
title: WorkflowFileReference
7201572027
description: A workflow that must run for this rule to pass

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

+21-6
Original file line numberDiff line numberDiff line change
@@ -25569,25 +25569,22 @@
2556925569
},
2557025570
"/repos/{owner}/{repo}/autolinks": {
2557125571
"get": {
25572-
"summary": "List all autolinks of a repository",
25573-
"description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
25572+
"summary": "Get all autolinks of a repository",
25573+
"description": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.",
2557425574
"tags": [
2557525575
"repos"
2557625576
],
2557725577
"operationId": "repos/list-autolinks",
2557825578
"externalDocs": {
2557925579
"description": "API method documentation",
25580-
"url": "https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository"
25580+
"url": "https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository"
2558125581
},
2558225582
"parameters": [
2558325583
{
2558425584
"$ref": "#/components/parameters/owner"
2558525585
},
2558625586
{
2558725587
"$ref": "#/components/parameters/repo"
25588-
},
25589-
{
25590-
"$ref": "#/components/parameters/page"
2559125588
}
2559225589
],
2559325590
"responses": {
@@ -98809,6 +98806,24 @@
9880998806
}
9881098807
}
9881198808
},
98809+
"repository-rule-params-restricted-commits": {
98810+
"title": "RestrictedCommits",
98811+
"description": "Restricted commit",
98812+
"type": "object",
98813+
"properties": {
98814+
"oid": {
98815+
"type": "string",
98816+
"description": "Full or abbreviated commit hash to reject"
98817+
},
98818+
"reason": {
98819+
"type": "string",
98820+
"description": "Reason for restriction"
98821+
}
98822+
},
98823+
"required": [
98824+
"oid"
98825+
]
98826+
},
9881298827
"repository-rule-params-workflow-file-reference": {
9881398828
"title": "WorkflowFileReference",
9881498829
"description": "A workflow that must run for this rule to pass",

0 commit comments

Comments
 (0)