Regen Specs

This commit is contained in:
Bradley Schofield 2024-11-13 09:22:47 +09:00
parent 6faad29907
commit aa42608528
6 changed files with 179 additions and 62 deletions

View file

@ -4540,11 +4540,11 @@
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"description": "BulkOperation",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
"$ref": "#\/components\/schemas\/bulkOperation"
}
}
}
@ -4620,6 +4620,14 @@
"description": "Document data as JSON object.",
"x-example": "{}"
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON object.",
"x-example": null,
"items": {
"type": "object"
}
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
@ -4628,11 +4636,7 @@
"type": "string"
}
}
},
"required": [
"documentId",
"data"
]
}
}
}
}
@ -9865,6 +9869,21 @@
"identifier",
"expired"
]
},
"bulkOperation": {
"description": "BulkOperation",
"type": "object",
"properties": {
"modified": {
"type": "integer",
"description": "Total number of documents affected by the operation.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"modified"
]
}
},
"securitySchemes": {

View file

@ -8109,11 +8109,11 @@
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"description": "BulkOperation",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
"$ref": "#\/components\/schemas\/bulkOperation"
}
}
}
@ -8189,6 +8189,14 @@
"description": "Document data as JSON object.",
"x-example": "{}"
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON object.",
"x-example": null,
"items": {
"type": "object"
}
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
@ -8197,11 +8205,7 @@
"type": "string"
}
}
},
"required": [
"documentId",
"data"
]
}
}
}
}
@ -20672,7 +20676,7 @@
},
"\/projects\/{projectId}\/auth\/memberships-privacy": {
"patch": {
"summary": "Update project team sensitive attributes",
"summary": "Update project memberships privacy attributes",
"operationId": "projectsUpdateMembershipsPrivacy",
"tags": [
"projects"
@ -36077,17 +36081,17 @@
"description": "Whether or not to send session alert emails to users.",
"x-example": true
},
"membershipsUserName": {
"authMembershipsUserName": {
"type": "boolean",
"description": "Whether or not to show user names in the teams membership response.",
"x-example": true
},
"membershipsUserEmail": {
"authMembershipsUserEmail": {
"type": "boolean",
"description": "Whether or not to show user emails in the teams membership response.",
"x-example": true
},
"membershipsMfa": {
"authMembershipsMfa": {
"type": "boolean",
"description": "Whether or not to show user MFA status in the teams membership response.",
"x-example": true
@ -36297,9 +36301,9 @@
"authPersonalDataCheck",
"authMockNumbers",
"authSessionAlerts",
"membershipsUserName",
"membershipsUserEmail",
"membershipsMfa",
"authMembershipsUserName",
"authMembershipsUserEmail",
"authMembershipsMfa",
"oAuthProviders",
"platforms",
"webhooks",
@ -38727,6 +38731,21 @@
"projectId",
"displayName"
]
},
"bulkOperation": {
"description": "BulkOperation",
"type": "object",
"properties": {
"modified": {
"type": "integer",
"description": "Total number of documents affected by the operation.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"modified"
]
}
},
"securitySchemes": {

View file

@ -7636,11 +7636,11 @@
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"description": "BulkOperation",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
"$ref": "#\/components\/schemas\/bulkOperation"
}
}
}
@ -7718,6 +7718,14 @@
"description": "Document data as JSON object.",
"x-example": "{}"
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON object.",
"x-example": null,
"items": {
"type": "object"
}
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
@ -7726,11 +7734,7 @@
"type": "string"
}
}
},
"required": [
"documentId",
"data"
]
}
}
}
}
@ -27097,6 +27101,21 @@
"identifier",
"expired"
]
},
"bulkOperation": {
"description": "BulkOperation",
"type": "object",
"properties": {
"modified": {
"type": "integer",
"description": "Total number of documents affected by the operation.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"modified"
]
}
},
"securitySchemes": {

View file

@ -4712,9 +4712,9 @@
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"description": "BulkOperation",
"schema": {
"$ref": "#\/definitions\/document"
"$ref": "#\/definitions\/bulkOperation"
}
}
},
@ -4776,15 +4776,24 @@
"documentId": {
"type": "string",
"description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
"default": null,
"default": "",
"x-example": "<DOCUMENT_ID>"
},
"data": {
"type": "object",
"description": "Document data as JSON object.",
"default": {},
"default": [],
"x-example": "{}"
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON object.",
"default": [],
"x-example": null,
"items": {
"type": "object"
}
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
@ -4794,11 +4803,7 @@
"type": "string"
}
}
},
"required": [
"documentId",
"data"
]
}
}
}
]
@ -10047,6 +10052,21 @@
"identifier",
"expired"
]
},
"bulkOperation": {
"description": "BulkOperation",
"type": "object",
"properties": {
"modified": {
"type": "integer",
"description": "Total number of documents affected by the operation.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"modified"
]
}
},
"externalDocs": {

View file

@ -8268,9 +8268,9 @@
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"description": "BulkOperation",
"schema": {
"$ref": "#\/definitions\/document"
"$ref": "#\/definitions\/bulkOperation"
}
}
},
@ -8332,15 +8332,24 @@
"documentId": {
"type": "string",
"description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
"default": null,
"default": "",
"x-example": "<DOCUMENT_ID>"
},
"data": {
"type": "object",
"description": "Document data as JSON object.",
"default": {},
"default": [],
"x-example": "{}"
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON object.",
"default": [],
"x-example": null,
"items": {
"type": "object"
}
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
@ -8350,11 +8359,7 @@
"type": "string"
}
}
},
"required": [
"documentId",
"data"
]
}
}
}
]
@ -21138,7 +21143,7 @@
},
"\/projects\/{projectId}\/auth\/memberships-privacy": {
"patch": {
"summary": "Update project team sensitive attributes",
"summary": "Update project memberships privacy attributes",
"operationId": "projectsUpdateMembershipsPrivacy",
"consumes": [
"application\/json"
@ -36591,17 +36596,17 @@
"description": "Whether or not to send session alert emails to users.",
"x-example": true
},
"membershipsUserName": {
"authMembershipsUserName": {
"type": "boolean",
"description": "Whether or not to show user names in the teams membership response.",
"x-example": true
},
"membershipsUserEmail": {
"authMembershipsUserEmail": {
"type": "boolean",
"description": "Whether or not to show user emails in the teams membership response.",
"x-example": true
},
"membershipsMfa": {
"authMembershipsMfa": {
"type": "boolean",
"description": "Whether or not to show user MFA status in the teams membership response.",
"x-example": true
@ -36815,9 +36820,9 @@
"authPersonalDataCheck",
"authMockNumbers",
"authSessionAlerts",
"membershipsUserName",
"membershipsUserEmail",
"membershipsMfa",
"authMembershipsUserName",
"authMembershipsUserEmail",
"authMembershipsMfa",
"oAuthProviders",
"platforms",
"webhooks",
@ -39294,6 +39299,21 @@
"projectId",
"displayName"
]
},
"bulkOperation": {
"description": "BulkOperation",
"type": "object",
"properties": {
"modified": {
"type": "integer",
"description": "Total number of documents affected by the operation.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"modified"
]
}
},
"externalDocs": {

View file

@ -7782,9 +7782,9 @@
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"description": "BulkOperation",
"schema": {
"$ref": "#\/definitions\/document"
"$ref": "#\/definitions\/bulkOperation"
}
}
},
@ -7848,15 +7848,24 @@
"documentId": {
"type": "string",
"description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
"default": null,
"default": "",
"x-example": "<DOCUMENT_ID>"
},
"data": {
"type": "object",
"description": "Document data as JSON object.",
"default": {},
"default": [],
"x-example": "{}"
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON object.",
"default": [],
"x-example": null,
"items": {
"type": "object"
}
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
@ -7866,11 +7875,7 @@
"type": "string"
}
}
},
"required": [
"documentId",
"data"
]
}
}
}
]
@ -27589,6 +27594,21 @@
"identifier",
"expired"
]
},
"bulkOperation": {
"description": "BulkOperation",
"type": "object",
"properties": {
"modified": {
"type": "integer",
"description": "Total number of documents affected by the operation.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"modified"
]
}
},
"externalDocs": {