Elgato_dark/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite synced 2026-05-22 16:38:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #10278 from appwrite/pla-3349

Browse source 
chore: add readonly param to sequence, databaseId and collectionId
This commit is contained in:
Jake Barnby 2025-08-08 23:52:25 +12:00 committed by GitHub
commit e94c8bfd97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 144 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
app/config/specs/open-api3-1.7.x-client.json
View file

@ -8479,17 +8479,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

16
app/config/specs/open-api3-1.7.x-console.json
View file

@ -37978,17 +37978,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",
@ -44635,6 +44638,11 @@
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
"_APP_DOMAIN_TARGET_CAA": {
"type": "string",
"description": "CAA target for your Appwrite custom domains.",
"x-example": "digicert.com"
},
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
@ -44692,6 +44700,7 @@
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_DOMAIN_TARGET_AAAA",
"_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
@ -44707,6 +44716,7 @@
"_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
"_APP_DOMAIN_TARGET_A": "127.0.0.1",
"_APP_DOMAIN_TARGET_AAAA": "::1",
"_APP_DOMAIN_TARGET_CAA": "digicert.com",
"_APP_STORAGE_LIMIT": "30000000",
"_APP_COMPUTE_SIZE_LIMIT": "30000000",
"_APP_USAGE_STATS": "enabled",

9
app/config/specs/open-api3-1.7.x-server.json
View file

@ -27864,17 +27864,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

9
app/config/specs/open-api3-latest-client.json
View file

@ -8479,17 +8479,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

16
app/config/specs/open-api3-latest-console.json
View file

@ -37978,17 +37978,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",
@ -44635,6 +44638,11 @@
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
"_APP_DOMAIN_TARGET_CAA": {
"type": "string",
"description": "CAA target for your Appwrite custom domains.",
"x-example": "digicert.com"
},
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
@ -44692,6 +44700,7 @@
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_DOMAIN_TARGET_AAAA",
"_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
@ -44707,6 +44716,7 @@
"_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
"_APP_DOMAIN_TARGET_A": "127.0.0.1",
"_APP_DOMAIN_TARGET_AAAA": "::1",
"_APP_DOMAIN_TARGET_CAA": "digicert.com",
"_APP_STORAGE_LIMIT": "30000000",
"_APP_COMPUTE_SIZE_LIMIT": "30000000",
"_APP_USAGE_STATS": "enabled",

9
app/config/specs/open-api3-latest-server.json
View file

@ -27864,17 +27864,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

9
app/config/specs/swagger2-1.7.x-client.json
View file

@ -8516,17 +8516,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

16
app/config/specs/swagger2-1.7.x-console.json
View file

@ -38139,17 +38139,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",
@ -44900,6 +44903,11 @@
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
"_APP_DOMAIN_TARGET_CAA": {
"type": "string",
"description": "CAA target for your Appwrite custom domains.",
"x-example": "digicert.com"
},
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
@ -44957,6 +44965,7 @@
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_DOMAIN_TARGET_AAAA",
"_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
@ -44972,6 +44981,7 @@
"_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
"_APP_DOMAIN_TARGET_A": "127.0.0.1",
"_APP_DOMAIN_TARGET_AAAA": "::1",
"_APP_DOMAIN_TARGET_CAA": "digicert.com",
"_APP_STORAGE_LIMIT": "30000000",
"_APP_COMPUTE_SIZE_LIMIT": "30000000",
"_APP_USAGE_STATS": "enabled",

9
app/config/specs/swagger2-1.7.x-server.json
View file

@ -28092,17 +28092,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

9
app/config/specs/swagger2-latest-client.json
View file

@ -8516,17 +8516,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

16
app/config/specs/swagger2-latest-console.json
View file

@ -38139,17 +38139,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",
@ -44900,6 +44903,11 @@
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
"_APP_DOMAIN_TARGET_CAA": {
"type": "string",
"description": "CAA target for your Appwrite custom domains.",
"x-example": "digicert.com"
},
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
@ -44957,6 +44965,7 @@
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_DOMAIN_TARGET_AAAA",
"_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
@ -44972,6 +44981,7 @@
"_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
"_APP_DOMAIN_TARGET_A": "127.0.0.1",
"_APP_DOMAIN_TARGET_AAAA": "::1",
"_APP_DOMAIN_TARGET_CAA": "digicert.com",
"_APP_STORAGE_LIMIT": "30000000",
"_APP_COMPUTE_SIZE_LIMIT": "30000000",
"_APP_USAGE_STATS": "enabled",

9
app/config/specs/swagger2-latest-server.json
View file

@ -28092,17 +28092,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32"
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e"
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",

7
src/Appwrite/SDK/Specification/Format/OpenAPI3.php
View file

@ -686,6 +686,7 @@ class OpenAPI3 extends Format
break;
}
$readOnly = $rule['readOnly'] ?? false;
if ($rule['array']) {
$output['components']['schemas'][$model->getType()]['properties'][$name] = [
'type' => 'array',
@ -699,6 +700,9 @@ class OpenAPI3 extends Format
if ($format) {
$output['components']['schemas'][$model->getType()]['properties'][$name]['items']['format'] = $format;
}
if ($readOnly) {
$output['components']['schemas'][$model->getType()]['properties'][$name]['readOnly'] = true;
}
} else {
$output['components']['schemas'][$model->getType()]['properties'][$name] = [
'type' => $type,
@ -709,6 +713,9 @@ class OpenAPI3 extends Format
if ($format) {
$output['components']['schemas'][$model->getType()]['properties'][$name]['format'] = $format;
}
if ($readOnly) {
$output['components']['schemas'][$model->getType()]['properties'][$name]['readOnly'] = true;
}
}
if ($items) {
$output['components']['schemas'][$model->getType()]['properties'][$name]['items'] = $items;

11
src/Appwrite/SDK/Specification/Format/Swagger2.php
View file

@ -692,6 +692,7 @@ class Swagger2 extends Format
break;
}
$readOnly = $rule['readOnly'] ?? false;
if ($rule['type'] == 'json') {
$output['definitions'][$model->getType()]['properties'][$name] = [
'type' => $type,
@ -699,6 +700,10 @@ class Swagger2 extends Format
'description' => $rule['description'] ?? '',
'x-example' => $rule['example'] ?? null,
];
if ($readOnly) {
$output['definitions'][$model->getType()]['properties'][$name]['readOnly'] = true;
}
continue;
}
@ -715,6 +720,9 @@ class Swagger2 extends Format
if ($format) {
$output['definitions'][$model->getType()]['properties'][$name]['items']['format'] = $format;
}
if ($readOnly) {
$output['definitions'][$model->getType()]['properties'][$name]['readOnly'] = true;
}
} else {
$output['definitions'][$model->getType()]['properties'][$name] = [
'type' => $type,
@ -725,6 +733,9 @@ class Swagger2 extends Format
if ($format) {
$output['definitions'][$model->getType()]['properties'][$name]['format'] = $format;
}
if ($readOnly) {
$output['definitions'][$model->getType()]['properties'][$name]['readOnly'] = true;
}
}
if ($items) {
$output['definitions'][$model->getType()]['properties'][$name]['items'] = $items;

24
src/Appwrite/Utopia/Response/Model.php
View file

@ -91,7 +91,8 @@ abstract class Model
'array' => false,
'description' => '',
'example' => '',
'sensitive' => false
'sensitive' => false,
'readOnly' => false
], $options);
return $this;
@ -129,6 +130,27 @@ abstract class Model
return $list;
}
/**
* Get Readonly Fields
*
* Returns list of field names that are marked as readOnly
* and should not be allowed in create/update payloads
*
* @return array
*/
public function getReadonlyFields(): array
{
$list = [];
foreach ($this->rules as $key => $rule) {
if ($rule['readOnly'] ?? false) {
$list[] = $key;
}
}
return $list;
}
/**
* Is None
*

3
src/Appwrite/Utopia/Response/Model/Document.php
View file

@ -41,18 +41,21 @@ class Document extends Any
'description' => 'Document automatically incrementing ID.',
'default' => 0,
'example' => 1,
'readOnly' => true,
])
->addRule('$collectionId', [
'type' => self::TYPE_STRING,
'description' => 'Collection ID.',
'default' => '',
'example' => '5e5ea5c15117e',
'readOnly' => true,
])
->addRule('$databaseId', [
'type' => self::TYPE_STRING,
'description' => 'Database ID.',
'default' => '',
'example' => '5e5ea5c15117e',
'readOnly' => true,
])
->addRule('$createdAt', [
'type' => self::TYPE_DATETIME,