Update Specs

This commit is contained in:
Bradley Schofield
2024-11-11 15:29:59 +09:00
parent c6ca830801
commit 07738bdcf9
6 changed files with 1605 additions and 968 deletions
+143 -37
View File
@@ -4637,6 +4637,112 @@
}
}
}
},
"patch": {
"summary": "Update documents",
"operationId": "databasesUpdateDocuments",
"tags": [
"databases"
],
"description": "Update all documents that match your queries, If none are submitted then all documents are updated. Using the patch method you can pass only specific fields that will get updated.",
"responses": {
"200": {
"description": "Documents List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/documentList"
}
}
}
}
},
"x-appwrite": {
"method": "updateDocuments",
"weight": 113,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "databases\/update-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"offline-model": "\/databases\/{databaseId}\/collections\/{collectionId}\/documents",
"offline-key": "",
"offline-response-key": "$id",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Session": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Document data as JSON object. Include only attribute and value pairs to be updated.",
"x-example": "{}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
}
},
"queries": {
"type": "array",
"description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
"x-example": null,
"items": {
"type": "string"
}
}
}
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": {
@@ -4859,7 +4965,7 @@
},
"x-appwrite": {
"method": "deleteDocument",
"weight": 113,
"weight": 114,
"cookies": false,
"type": "",
"deprecated": false,
@@ -4945,7 +5051,7 @@
},
"x-appwrite": {
"method": "listExecutions",
"weight": 306,
"weight": 307,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5033,7 +5139,7 @@
},
"x-appwrite": {
"method": "createExecution",
"weight": 305,
"weight": 306,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5150,7 +5256,7 @@
},
"x-appwrite": {
"method": "getExecution",
"weight": 307,
"weight": 308,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5226,7 +5332,7 @@
},
"x-appwrite": {
"method": "query",
"weight": 331,
"weight": 332,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -5280,7 +5386,7 @@
},
"x-appwrite": {
"method": "mutation",
"weight": 330,
"weight": 331,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -5334,7 +5440,7 @@
},
"x-appwrite": {
"method": "get",
"weight": 117,
"weight": 118,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5388,7 +5494,7 @@
},
"x-appwrite": {
"method": "listCodes",
"weight": 118,
"weight": 119,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5442,7 +5548,7 @@
},
"x-appwrite": {
"method": "listContinents",
"weight": 122,
"weight": 123,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5496,7 +5602,7 @@
},
"x-appwrite": {
"method": "listCountries",
"weight": 119,
"weight": 120,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5550,7 +5656,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"weight": 120,
"weight": 121,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5604,7 +5710,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"weight": 121,
"weight": 122,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5658,7 +5764,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"weight": 123,
"weight": 124,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5712,7 +5818,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"weight": 124,
"weight": 125,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5766,7 +5872,7 @@
},
"x-appwrite": {
"method": "createSubscriber",
"weight": 382,
"weight": 383,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5851,7 +5957,7 @@
},
"x-appwrite": {
"method": "deleteSubscriber",
"weight": 386,
"weight": 387,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5928,7 +6034,7 @@
},
"x-appwrite": {
"method": "listFiles",
"weight": 208,
"weight": 209,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6016,7 +6122,7 @@
},
"x-appwrite": {
"method": "createFile",
"weight": 207,
"weight": 208,
"cookies": false,
"type": "upload",
"deprecated": false,
@@ -6116,7 +6222,7 @@
},
"x-appwrite": {
"method": "getFile",
"weight": 209,
"weight": 210,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6190,7 +6296,7 @@
},
"x-appwrite": {
"method": "updateFile",
"weight": 214,
"weight": 215,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6281,7 +6387,7 @@
},
"x-appwrite": {
"method": "deleteFile",
"weight": 215,
"weight": 216,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6350,7 +6456,7 @@
},
"x-appwrite": {
"method": "getFileDownload",
"weight": 211,
"weight": 212,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -6419,7 +6525,7 @@
},
"x-appwrite": {
"method": "getFilePreview",
"weight": 210,
"weight": 211,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -6637,7 +6743,7 @@
},
"x-appwrite": {
"method": "getFileView",
"weight": 212,
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -6713,7 +6819,7 @@
},
"x-appwrite": {
"method": "list",
"weight": 219,
"weight": 220,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6791,7 +6897,7 @@
},
"x-appwrite": {
"method": "create",
"weight": 218,
"weight": 219,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6878,7 +6984,7 @@
},
"x-appwrite": {
"method": "get",
"weight": 220,
"weight": 221,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6942,7 +7048,7 @@
},
"x-appwrite": {
"method": "updateName",
"weight": 222,
"weight": 223,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7018,7 +7124,7 @@
},
"x-appwrite": {
"method": "delete",
"weight": 224,
"weight": 225,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7084,7 +7190,7 @@
},
"x-appwrite": {
"method": "listMemberships",
"weight": 226,
"weight": 227,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7172,7 +7278,7 @@
},
"x-appwrite": {
"method": "createMembership",
"weight": 225,
"weight": 226,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7285,7 +7391,7 @@
},
"x-appwrite": {
"method": "getMembership",
"weight": 227,
"weight": 228,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7359,7 +7465,7 @@
},
"x-appwrite": {
"method": "updateMembership",
"weight": 228,
"weight": 229,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7448,7 +7554,7 @@
},
"x-appwrite": {
"method": "deleteMembership",
"weight": 230,
"weight": 231,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7524,7 +7630,7 @@
},
"x-appwrite": {
"method": "updateMembershipStatus",
"weight": 229,
"weight": 230,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7624,7 +7730,7 @@
},
"x-appwrite": {
"method": "getPrefs",
"weight": 221,
"weight": 222,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7687,7 +7793,7 @@
},
"x-appwrite": {
"method": "updatePrefs",
"weight": 223,
"weight": 224,
"cookies": false,
"type": "",
"deprecated": false,
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+142 -37
View File
@@ -4802,6 +4802,111 @@
}
}
]
},
"patch": {
"summary": "Update documents",
"operationId": "databasesUpdateDocuments",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"databases"
],
"description": "Update all documents that match your queries, If none are submitted then all documents are updated. Using the patch method you can pass only specific fields that will get updated.",
"responses": {
"200": {
"description": "Documents List",
"schema": {
"$ref": "#\/definitions\/documentList"
}
}
},
"x-appwrite": {
"method": "updateDocuments",
"weight": 113,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "databases\/update-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"offline-model": "\/databases\/{databaseId}\/collections\/{collectionId}\/documents",
"offline-key": "",
"offline-response-key": "$id",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Session": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"type": "string",
"x-example": "<DATABASE_ID>",
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"type": "string",
"x-example": "<COLLECTION_ID>",
"in": "path"
},
{
"name": "payload",
"in": "body",
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Document data as JSON object. Include only attribute and value pairs to be updated.",
"default": [],
"x-example": "{}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"default": null,
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
}
},
"queries": {
"type": "array",
"description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
"default": [],
"x-example": null,
"items": {
"type": "string"
}
}
}
}
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": {
@@ -5019,7 +5124,7 @@
},
"x-appwrite": {
"method": "deleteDocument",
"weight": 113,
"weight": 114,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5101,7 +5206,7 @@
},
"x-appwrite": {
"method": "listExecutions",
"weight": 306,
"weight": 307,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5186,7 +5291,7 @@
},
"x-appwrite": {
"method": "createExecution",
"weight": 305,
"weight": 306,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5307,7 +5412,7 @@
},
"x-appwrite": {
"method": "getExecution",
"weight": 307,
"weight": 308,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5381,7 +5486,7 @@
},
"x-appwrite": {
"method": "query",
"weight": 331,
"weight": 332,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -5457,7 +5562,7 @@
},
"x-appwrite": {
"method": "mutation",
"weight": 330,
"weight": 331,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -5533,7 +5638,7 @@
},
"x-appwrite": {
"method": "get",
"weight": 117,
"weight": 118,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5589,7 +5694,7 @@
},
"x-appwrite": {
"method": "listCodes",
"weight": 118,
"weight": 119,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5645,7 +5750,7 @@
},
"x-appwrite": {
"method": "listContinents",
"weight": 122,
"weight": 123,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5701,7 +5806,7 @@
},
"x-appwrite": {
"method": "listCountries",
"weight": 119,
"weight": 120,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5757,7 +5862,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"weight": 120,
"weight": 121,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5813,7 +5918,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"weight": 121,
"weight": 122,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5869,7 +5974,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"weight": 123,
"weight": 124,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5925,7 +6030,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"weight": 124,
"weight": 125,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5981,7 +6086,7 @@
},
"x-appwrite": {
"method": "createSubscriber",
"weight": 382,
"weight": 383,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6070,7 +6175,7 @@
},
"x-appwrite": {
"method": "deleteSubscriber",
"weight": 386,
"weight": 387,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6145,7 +6250,7 @@
},
"x-appwrite": {
"method": "listFiles",
"weight": 208,
"weight": 209,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6230,7 +6335,7 @@
},
"x-appwrite": {
"method": "createFile",
"weight": 207,
"weight": 208,
"cookies": false,
"type": "upload",
"deprecated": false,
@@ -6324,7 +6429,7 @@
},
"x-appwrite": {
"method": "getFile",
"weight": 209,
"weight": 210,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6396,7 +6501,7 @@
},
"x-appwrite": {
"method": "updateFile",
"weight": 214,
"weight": 215,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6487,7 +6592,7 @@
},
"x-appwrite": {
"method": "deleteFile",
"weight": 215,
"weight": 216,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6561,7 +6666,7 @@
},
"x-appwrite": {
"method": "getFileDownload",
"weight": 211,
"weight": 212,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -6635,7 +6740,7 @@
},
"x-appwrite": {
"method": "getFilePreview",
"weight": 210,
"weight": 211,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -6836,7 +6941,7 @@
},
"x-appwrite": {
"method": "getFileView",
"weight": 212,
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -6910,7 +7015,7 @@
},
"x-appwrite": {
"method": "list",
"weight": 219,
"weight": 220,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6987,7 +7092,7 @@
},
"x-appwrite": {
"method": "create",
"weight": 218,
"weight": 219,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7081,7 +7186,7 @@
},
"x-appwrite": {
"method": "get",
"weight": 220,
"weight": 221,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7145,7 +7250,7 @@
},
"x-appwrite": {
"method": "updateName",
"weight": 222,
"weight": 223,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7222,7 +7327,7 @@
},
"x-appwrite": {
"method": "delete",
"weight": 224,
"weight": 225,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7288,7 +7393,7 @@
},
"x-appwrite": {
"method": "listMemberships",
"weight": 226,
"weight": 227,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7373,7 +7478,7 @@
},
"x-appwrite": {
"method": "createMembership",
"weight": 225,
"weight": 226,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7490,7 +7595,7 @@
},
"x-appwrite": {
"method": "getMembership",
"weight": 227,
"weight": 228,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7562,7 +7667,7 @@
},
"x-appwrite": {
"method": "updateMembership",
"weight": 228,
"weight": 229,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7650,7 +7755,7 @@
},
"x-appwrite": {
"method": "deleteMembership",
"weight": 230,
"weight": 231,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7724,7 +7829,7 @@
},
"x-appwrite": {
"method": "updateMembershipStatus",
"weight": 229,
"weight": 230,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7822,7 +7927,7 @@
},
"x-appwrite": {
"method": "getPrefs",
"weight": 221,
"weight": 222,
"cookies": false,
"type": "",
"deprecated": false,
@@ -7885,7 +7990,7 @@
},
"x-appwrite": {
"method": "updatePrefs",
"weight": 223,
"weight": 224,
"cookies": false,
"type": "",
"deprecated": false,
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff