Skip to content

Commit f28470c

Browse files
lohanidamodarlohanidamodar
committed
spec fix
1 parent a070000 commit f28470c

File tree

6 files changed

+9
-107
lines changed

6 files changed

+9
-107
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 6.0.1
2+
* Dependency upgrades
3+
* Doc comments updates
4+
* Cleanup code
5+
16
## 6.0.0
27
* Support for Appwrite 0.15
38
* **BREAKING** `Database` -> `Databases`

‎docs/examples/functions/create.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ void main() { // Init SDK
1313
Future result = functions.create(
1414
functionId: '[FUNCTION_ID]',
1515
name: '[NAME]',
16-
execute: ["role:all"],
16+
execute: [],
1717
runtime: 'node-14.5',
1818
);
1919

‎docs/examples/functions/update.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ void main() { // Init SDK
1313
Future result = functions.update(
1414
functionId: '[FUNCTION_ID]',
1515
name: '[NAME]',
16-
execute: ["role:all"],
16+
execute: [],
1717
);
1818

1919
result

‎lib/services/databases.dart‎

Lines changed: 0 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ class Databases extends Service {
77
String databaseId;
88

99
/// List Databases
10-
///
11-
/// Get a list of all databases from the current Appwrite project. You can use
12-
/// the search parameter to filter your results.
13-
///
1410
Future<models.DatabaseList> list({String? search, int? limit, int? offset, String? cursor, String? cursorDirection, String? orderType}) async {
1511
final String path = '/databases';
1612

@@ -38,10 +34,6 @@ class Databases extends Service {
3834
}
3935

4036
/// Create Database
41-
///
42-
/// Create a new Database.
43-
///
44-
///
4537
Future<models.Database> create({required String name}) async {
4638
final String path = '/databases';
4739

@@ -65,10 +57,6 @@ class Databases extends Service {
6557
}
6658

6759
/// Get Database
68-
///
69-
/// Get a database by its unique ID. This endpoint response returns a JSON
70-
/// object with the database metadata.
71-
///
7260
Future<models.Collection> get() async {
7361
final String path = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId);
7462

@@ -90,9 +78,6 @@ class Databases extends Service {
9078
}
9179

9280
/// Update Database
93-
///
94-
/// Update a database by its unique ID.
95-
///
9681
Future<models.Collection> update({required String name}) async {
9782
final String path = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId);
9883

@@ -115,10 +100,6 @@ class Databases extends Service {
115100
}
116101

117102
/// Delete Database
118-
///
119-
/// Delete a database by its unique ID. Only API keys with with databases.write
120-
/// scope can delete a database.
121-
///
122103
Future delete() async {
123104
final String path = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId);
124105

@@ -140,10 +121,6 @@ class Databases extends Service {
140121
}
141122

142123
/// List Collections
143-
///
144-
/// Get a list of all collections that belong to the provided databaseId. You
145-
/// can use the search parameter to filter your results.
146-
///
147124
Future<models.CollectionList> listCollections({String? search, int? limit, int? offset, String? cursor, String? cursorDirection, String? orderType}) async {
148125
final String path = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId);
149126

@@ -171,12 +148,6 @@ class Databases extends Service {
171148
}
172149

173150
/// Create Collection
174-
///
175-
/// Create a new Collection. Before using this route, you should create a new
176-
/// database resource using either a [server
177-
/// integration](/docs/server/database#databaseCreateCollection) API or
178-
/// directly from your database console.
179-
///
180151
Future<models.Collection> createCollection({required String collectionId, required String name, required String permission, required List read, required List write}) async {
181152
final String path = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId);
182153

@@ -203,10 +174,6 @@ class Databases extends Service {
203174
}
204175

205176
/// Get Collection
206-
///
207-
/// Get a collection by its unique ID. This endpoint response returns a JSON
208-
/// object with the collection metadata.
209-
///
210177
Future<models.Collection> getCollection({required String collectionId}) async {
211178
final String path = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
212179

@@ -228,9 +195,6 @@ class Databases extends Service {
228195
}
229196

230197
/// Update Collection
231-
///
232-
/// Update a collection by its unique ID.
233-
///
234198
Future<models.Collection> updateCollection({required String collectionId, required String name, required String permission, List? read, List? write, bool? enabled}) async {
235199
final String path = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
236200

@@ -257,10 +221,6 @@ class Databases extends Service {
257221
}
258222

259223
/// Delete Collection
260-
///
261-
/// Delete a collection by its unique ID. Only users with write permissions
262-
/// have access to delete this resource.
263-
///
264224
Future deleteCollection({required String collectionId}) async {
265225
final String path = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
266226

@@ -303,10 +263,6 @@ class Databases extends Service {
303263
}
304264

305265
/// Create Boolean Attribute
306-
///
307-
/// Create a boolean attribute.
308-
///
309-
///
310266
Future<models.AttributeBoolean> createBooleanAttribute({required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async {
311267
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
312268

@@ -332,10 +288,6 @@ class Databases extends Service {
332288
}
333289

334290
/// Create Email Attribute
335-
///
336-
/// Create an email attribute.
337-
///
338-
///
339291
Future<models.AttributeEmail> createEmailAttribute({required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async {
340292
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
341293

@@ -387,11 +339,6 @@ class Databases extends Service {
387339
}
388340

389341
/// Create Float Attribute
390-
///
391-
/// Create a float attribute. Optionally, minimum and maximum values can be
392-
/// provided.
393-
///
394-
///
395342
Future<models.AttributeFloat> createFloatAttribute({required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async {
396343
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
397344

@@ -419,11 +366,6 @@ class Databases extends Service {
419366
}
420367

421368
/// Create Integer Attribute
422-
///
423-
/// Create an integer attribute. Optionally, minimum and maximum values can be
424-
/// provided.
425-
///
426-
///
427369
Future<models.AttributeInteger> createIntegerAttribute({required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async {
428370
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
429371

@@ -451,10 +393,6 @@ class Databases extends Service {
451393
}
452394

453395
/// Create IP Address Attribute
454-
///
455-
/// Create IP address attribute.
456-
///
457-
///
458396
Future<models.AttributeIp> createIpAttribute({required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async {
459397
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
460398

@@ -480,10 +418,6 @@ class Databases extends Service {
480418
}
481419

482420
/// Create String Attribute
483-
///
484-
/// Create a string attribute.
485-
///
486-
///
487421
Future<models.AttributeString> createStringAttribute({required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array}) async {
488422
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
489423

@@ -510,10 +444,6 @@ class Databases extends Service {
510444
}
511445

512446
/// Create URL Attribute
513-
///
514-
/// Create a URL attribute.
515-
///
516-
///
517447
Future<models.AttributeUrl> createUrlAttribute({required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async {
518448
final String path = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
519449

@@ -581,12 +511,6 @@ class Databases extends Service {
581511
}
582512

583513
/// List Documents
584-
///
585-
/// Get a list of all the user's documents in a given collection. You can use
586-
/// the query params to filter your results. On admin mode, this endpoint will
587-
/// return a list of all of documents belonging to the provided collectionId.
588-
/// [Learn more about different API modes](/docs/admin).
589-
///
590514
Future<models.DocumentList> listDocuments({required String collectionId, List? queries, int? limit, int? offset, String? cursor, String? cursorDirection, List? orderAttributes, List? orderTypes}) async {
591515
final String path = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
592516

@@ -615,12 +539,6 @@ class Databases extends Service {
615539
}
616540

617541
/// Create Document
618-
///
619-
/// Create a new Document. Before using this route, you should create a new
620-
/// collection resource using either a [server
621-
/// integration](/docs/server/database#databaseCreateCollection) API or
622-
/// directly from your database console.
623-
///
624542
Future<models.Document> createDocument({required String collectionId, required String documentId, required Map data, List? read, List? write}) async {
625543
final String path = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId);
626544

@@ -646,10 +564,6 @@ class Databases extends Service {
646564
}
647565

648566
/// Get Document
649-
///
650-
/// Get a document by its unique ID. This endpoint response returns a JSON
651-
/// object with the document data.
652-
///
653567
Future<models.Document> getDocument({required String collectionId, required String documentId}) async {
654568
final String path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId);
655569

@@ -671,10 +585,6 @@ class Databases extends Service {
671585
}
672586

673587
/// Update Document
674-
///
675-
/// Update a document by its unique ID. Using the patch method you can pass
676-
/// only specific fields that will get updated.
677-
///
678588
Future<models.Document> updateDocument({required String collectionId, required String documentId, Map? data, List? read, List? write}) async {
679589
final String path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId);
680590

@@ -699,9 +609,6 @@ class Databases extends Service {
699609
}
700610

701611
/// Delete Document
702-
///
703-
/// Delete a document by its unique ID.
704-
///
705612
Future deleteDocument({required String collectionId, required String documentId}) async {
706613
final String path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId);
707614

‎lib/services/functions.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ class Functions extends Service {
252252
///
253253
/// Get a code deployment by its unique ID.
254254
///
255-
Future<models.Deployment> getDeployment({required String functionId, required String deploymentId}) async {
255+
Future<models.DeploymentList> getDeployment({required String functionId, required String deploymentId}) async {
256256
final String path = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId);
257257

258258
final Map<String, dynamic> params = {
@@ -267,7 +267,7 @@ class Functions extends Service {
267267

268268
final res = await client.call(HttpMethod.get, path: path, params: params, headers: headers);
269269

270-
return models.Deployment.fromMap(res.data);
270+
return models.DeploymentList.fromMap(res.data);
271271

272272

273273
}

‎lib/src/models/database.dart‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,23 @@ class Database {
66
final String $id;
77
/// Database name.
88
final String name;
9-
/// Collection creation date in Unix timestamp.
10-
final int $createdAt;
11-
/// Collection update date in Unix timestamp.
12-
final int $updatedAt;
139

1410
Database({
1511
required this.$id,
1612
required this.name,
17-
required this.$createdAt,
18-
required this.$updatedAt,
1913
});
2014

2115
factory Database.fromMap(Map<String, dynamic> map) {
2216
return Database(
2317
$id: map['\$id'].toString(),
2418
name: map['name'].toString(),
25-
$createdAt: map['\$createdAt'],
26-
$updatedAt: map['\$updatedAt'],
2719
);
2820
}
2921

3022
Map<String, dynamic> toMap() {
3123
return {
3224
"\$id": $id,
3325
"name": name,
34-
"\$createdAt": $createdAt,
35-
"\$updatedAt": $updatedAt,
3626
};
3727
}
3828
}

0 commit comments

Comments
 (0)