summaryrefslogtreecommitdiffstats
path: root/descriptions-next/api.github.com
diff options
context:
space:
mode:
authorgithub-openapi-bot <security+github-openapi-bot@github.com>2022-09-14 14:21:38 -0700
committergithub-openapi-bot <security+github-openapi-bot@github.com>2022-09-14 14:21:38 -0700
commit3fea1409f3bc74ed62bc1f3b0227806210547fbd (patch)
treec2132caab62d4a787d45fdb2505a3a6e4ca4f1d9 /descriptions-next/api.github.com
parente09f172de949ef5f18314cc2922c3a835be0e327 (diff)
downloadrest-api-description-3fea1409f3bc74ed62bc1f3b0227806210547fbd.tar.gz
rest-api-description-3fea1409f3bc74ed62bc1f3b0227806210547fbd.zip
Update OpenAPI 3.1 Descriptions
Diffstat (limited to 'descriptions-next/api.github.com')
-rw-r--r--descriptions-next/api.github.com/api.github.com.json4
-rw-r--r--descriptions-next/api.github.com/api.github.com.yaml9
-rw-r--r--descriptions-next/api.github.com/dereferenced/api.github.com.deref.json4
-rw-r--r--descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml9
4 files changed, 16 insertions, 10 deletions
diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json
index f81032d59..9c2b56cdf 100644
--- a/descriptions-next/api.github.com/api.github.com.json
+++ b/descriptions-next/api.github.com/api.github.com.json
@@ -31035,7 +31035,7 @@
},
"put": {
"summary": "Create or update file contents",
- "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.",
+ "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.",
"tags": [
"repos"
],
@@ -31217,7 +31217,7 @@
},
"delete": {
"summary": "Delete a file",
- "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.",
+ "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.",
"tags": [
"repos"
],
diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml
index 29ccee7dd..eb9330b02 100644
--- a/descriptions-next/api.github.com/api.github.com.yaml
+++ b/descriptions-next/api.github.com/api.github.com.yaml
@@ -22443,9 +22443,10 @@ paths:
subcategory: contents
put:
summary: Create or update file contents
- 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.
+ 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.
+
+ **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.
tags:
- repos
operationId: repos/create-or-update-file-contents
@@ -22584,6 +22585,8 @@ paths:
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.
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.
+
+ **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.
tags:
- repos
operationId: repos/delete-file
diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
index 05db764f7..4a77499c2 100644
--- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
+++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
@@ -284463,7 +284463,7 @@
},
"put": {
"summary": "Create or update file contents",
- "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.",
+ "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.",
"tags": [
"repos"
],
@@ -285189,7 +285189,7 @@
},
"delete": {
"summary": "Delete a file",
- "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.",
+ "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.",
"tags": [
"repos"
],
diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
index 175402c8a..6555d7f64 100644
--- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
+++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
@@ -48993,9 +48993,10 @@ paths:
subcategory: contents
put:
summary: Create or update file contents
- 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.
+ 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.
+
+ **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.
tags:
- repos
operationId: repos/create-or-update-file-contents
@@ -49312,6 +49313,8 @@ paths:
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.
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.
+
+ **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.
tags:
- repos
operationId: repos/delete-file