Skip to content

Commit 76ce811

Browse files
Update OpenAPI 3.0 Descriptions
1 parent e09f172 commit 76ce811

29 files changed

+112
-70
lines changed

1

Whitespace-only changes.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30885,7 +30885,7 @@
3088530885
},
3088630886
"put": {
3088730887
"summary": "Create or update file contents",
30888-
"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.",
30888+
"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.",
3088930889
"tags": [
3089030890
"repos"
3089130891
],
@@ -31063,7 +31063,7 @@
3106331063
},
3106431064
"delete": {
3106531065
"summary": "Delete a file",
31066-
"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.",
31066+
"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.",
3106731067
"tags": [
3106831068
"repos"
3106931069
],

descriptions/api.github.com/api.github.com.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22371,9 +22371,10 @@ paths:
2237122371
subcategory: contents
2237222372
put:
2237322373
summary: Create or update file contents
22374-
description: Creates a new file or replaces an existing file in a repository.
22375-
You must authenticate using an access token with the `workflow` scope to use
22376-
this endpoint.
22374+
description: |-
22375+
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.
22376+
22377+
**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.
2237722378
tags:
2237822379
- repos
2237922380
operationId: repos/create-or-update-file-contents
@@ -22510,6 +22511,8 @@ paths:
2251022511
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.
2251122512

2251222513
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.
22514+
22515+
**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.
2251322516
tags:
2251422517
- repos
2251522518
operationId: repos/delete-file

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240901,7 +240901,7 @@
240901240901
},
240902240902
"put": {
240903240903
"summary": "Create or update file contents",
240904-
"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.",
240904+
"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.",
240905240905
"tags": [
240906240906
"repos"
240907240907
],
@@ -241605,7 +241605,7 @@
241605241605
},
241606241606
"delete": {
241607241607
"summary": "Delete a file",
241608-
"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.",
241608+
"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.",
241609241609
"tags": [
241610241610
"repos"
241611241611
],

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47699,9 +47699,10 @@ paths:
4769947699
subcategory: contents
4770047700
put:
4770147701
summary: Create or update file contents
47702-
description: Creates a new file or replaces an existing file in a repository.
47703-
You must authenticate using an access token with the `workflow` scope to use
47704-
this endpoint.
47702+
description: |-
47703+
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.
47704+
47705+
**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.
4770547706
tags:
4770647707
- repos
4770747708
operationId: repos/create-or-update-file-contents
@@ -48013,6 +48014,8 @@ paths:
4801348014
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.
4801448015

4801548016
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.
48017+
48018+
**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.
4801648019
tags:
4801748020
- repos
4801848021
operationId: repos/delete-file

0 commit comments

Comments
 (0)