Skip to content

Commit 62bb541

Browse files
authored
Merge pull request #1551 from github/openapi-update-43235b09ff35d0a0e52e42ef2eed0bb8c6bca0dec2379858fd70349c686fe294
Update OpenAPI 3.1 Descriptions
2 parents e09f172 + 3fea140 commit 62bb541

29 files changed

+112
-70
lines changed

1

Whitespace-only changes.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31035,7 +31035,7 @@
3103531035
},
3103631036
"put": {
3103731037
"summary": "Create or update file contents",
31038-
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
31038+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
3103931039
"tags": [
3104031040
"repos"
3104131041
],
@@ -31217,7 +31217,7 @@
3121731217
},
3121831218
"delete": {
3121931219
"summary": "Delete a file",
31220-
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
31220+
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
3122131221
"tags": [
3122231222
"repos"
3122331223
],

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22443,9 +22443,10 @@ paths:
2244322443
subcategory: contents
2244422444
put:
2244522445
summary: Create or update file contents
22446-
description: Creates a new file or replaces an existing file in a repository.
22447-
You must authenticate using an access token with the `workflow` scope to use
22448-
this endpoint.
22446+
description: |-
22447+
Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
22448+
22449+
**Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
2244922450
tags:
2245022451
- repos
2245122452
operationId: repos/create-or-update-file-contents
@@ -22584,6 +22585,8 @@ paths:
2258422585
The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.
2258522586

2258622587
You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.
22588+
22589+
**Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
2258722590
tags:
2258822591
- repos
2258922592
operationId: repos/delete-file

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284463,7 +284463,7 @@
284463284463
},
284464284464
"put": {
284465284465
"summary": "Create or update file contents",
284466-
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
284466+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
284467284467
"tags": [
284468284468
"repos"
284469284469
],
@@ -285189,7 +285189,7 @@
285189285189
},
285190285190
"delete": {
285191285191
"summary": "Delete a file",
285192-
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
285192+
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
285193285193
"tags": [
285194285194
"repos"
285195285195
],

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48993,9 +48993,10 @@ paths:
4899348993
subcategory: contents
4899448994
put:
4899548995
summary: Create or update file contents
48996-
description: Creates a new file or replaces an existing file in a repository.
48997-
You must authenticate using an access token with the `workflow` scope to use
48998-
this endpoint.
48996+
description: |-
48997+
Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
48998+
48999+
**Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
4899949000
tags:
4900049001
- repos
4900149002
operationId: repos/create-or-update-file-contents
@@ -49312,6 +49313,8 @@ paths:
4931249313
The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.
4931349314

4931449315
You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.
49316+
49317+
**Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
4931549318
tags:
4931649319
- repos
4931749320
operationId: repos/delete-file

0 commit comments

Comments
 (0)