CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-09-30 09:18:14 +13:00
Code Issues Projects Releases Wiki Activity

Updated docs

Browse source
This commit is contained in:
Eldad Fux 2020-06-19 21:55:08 +03:00
parent 27a8406be6
commit 0c8ece309f
1 changed files with 55 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

110
app/controllers/api/database.php
View file

@ -169,69 +169,69 @@ $utopia->get('/v1/database/collections/:collectionId')
} }
); );
$utopia->get('/v1/database/collections/:collectionId/logs') // $utopia->get('/v1/database/collections/:collectionId/logs')
->desc('Get Collection Logs') // ->desc('Get Collection Logs')
->label('scope', 'collections.read') // ->label('scope', 'collections.read')
->label('sdk.platform', [APP_PLATFORM_SERVER]) // ->label('sdk.platform', [APP_PLATFORM_SERVER])
->label('sdk.namespace', 'database') // ->label('sdk.namespace', 'database')
->label('sdk.method', 'getCollectionLogs') // ->label('sdk.method', 'getCollectionLogs')
->label('sdk.description', '/docs/references/database/get-collection-logs.md') // ->label('sdk.description', '/docs/references/database/get-collection-logs.md')
->param('collectionId', '', function () { return new UID(); }, 'Collection unique ID.') // ->param('collectionId', '', function () { return new UID(); }, 'Collection unique ID.')
->action( // ->action(
function ($collectionId) use ($response, $register, $projectDB, $project) { // function ($collectionId) use ($response, $register, $projectDB, $project) {
$collection = $projectDB->getDocument($collectionId); // $collection = $projectDB->getDocument($collectionId);
if (empty($collection->getId()) || Database::SYSTEM_COLLECTION_COLLECTIONS != $collection->getCollection()) { // if (empty($collection->getId()) || Database::SYSTEM_COLLECTION_COLLECTIONS != $collection->getCollection()) {
throw new Exception('Collection not found', 404); // throw new Exception('Collection not found', 404);
} // }
$adapter = new AuditAdapter($register->get('db')); // $adapter = new AuditAdapter($register->get('db'));
$adapter->setNamespace('app_'.$project->getId()); // $adapter->setNamespace('app_'.$project->getId());
$audit = new Audit($adapter); // $audit = new Audit($adapter);
$countries = Locale::getText('countries'); // $countries = Locale::getText('countries');
$logs = $audit->getLogsByResource('database/collection/'.$collection->getId()); // $logs = $audit->getLogsByResource('database/collection/'.$collection->getId());
$reader = new Reader(__DIR__.'/../../db/DBIP/dbip-country-lite-2020-01.mmdb'); // $reader = new Reader(__DIR__.'/../../db/DBIP/dbip-country-lite-2020-01.mmdb');
$output = []; // $output = [];
foreach ($logs as $i => &$log) { // foreach ($logs as $i => &$log) {
$log['userAgent'] = (!empty($log['userAgent'])) ? $log['userAgent'] : 'UNKNOWN'; // $log['userAgent'] = (!empty($log['userAgent'])) ? $log['userAgent'] : 'UNKNOWN';
$dd = new DeviceDetector($log['userAgent']); // $dd = new DeviceDetector($log['userAgent']);
$dd->skipBotDetection(); // OPTIONAL: If called, bot detection will completely be skipped (bots will be detected as regular devices then) // $dd->skipBotDetection(); // OPTIONAL: If called, bot detection will completely be skipped (bots will be detected as regular devices then)
$dd->parse(); // $dd->parse();
$output[$i] = [ // $output[$i] = [
'event' => $log['event'], // 'event' => $log['event'],
'ip' => $log['ip'], // 'ip' => $log['ip'],
'time' => strtotime($log['time']), // 'time' => strtotime($log['time']),
'OS' => $dd->getOs(), // 'OS' => $dd->getOs(),
'client' => $dd->getClient(), // 'client' => $dd->getClient(),
'device' => $dd->getDevice(), // 'device' => $dd->getDevice(),
'brand' => $dd->getBrand(), // 'brand' => $dd->getBrand(),
'model' => $dd->getModel(), // 'model' => $dd->getModel(),
'geo' => [], // 'geo' => [],
]; // ];
try { // try {
$record = $reader->country($log['ip']); // $record = $reader->country($log['ip']);
$output[$i]['geo']['isoCode'] = strtolower($record->country->isoCode); // $output[$i]['geo']['isoCode'] = strtolower($record->country->isoCode);
$output[$i]['geo']['country'] = $record->country->name; // $output[$i]['geo']['country'] = $record->country->name;
$output[$i]['geo']['country'] = (isset($countries[$record->country->isoCode])) ? $countries[$record->country->isoCode] : Locale::getText('locale.country.unknown'); // $output[$i]['geo']['country'] = (isset($countries[$record->country->isoCode])) ? $countries[$record->country->isoCode] : Locale::getText('locale.country.unknown');
} catch (\Exception $e) { // } catch (\Exception $e) {
$output[$i]['geo']['isoCode'] = '--'; // $output[$i]['geo']['isoCode'] = '--';
$output[$i]['geo']['country'] = Locale::getText('locale.country.unknown'); // $output[$i]['geo']['country'] = Locale::getText('locale.country.unknown');
} // }
} // }
$response->json($output); // $response->json($output);
} // }
); // );
$utopia->put('/v1/database/collections/:collectionId') $utopia->put('/v1/database/collections/:collectionId')
->desc('Update Collection') ->desc('Update Collection')
@ -350,7 +350,7 @@ $utopia->post('/v1/database/collections/:collectionId/documents')
->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER])
->label('sdk.method', 'createDocument') ->label('sdk.method', 'createDocument')
->label('sdk.description', '/docs/references/database/create-document.md') ->label('sdk.description', '/docs/references/database/create-document.md')
->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/database?platform=server#createCollection).') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/server/database#createCollection).')
->param('data', [], function () { return new \Utopia\Validator\Mock(); }, 'Document data as JSON object.') ->param('data', [], function () { return new \Utopia\Validator\Mock(); }, 'Document data as JSON object.')
->param('read', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.') ->param('read', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
->param('write', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.') ->param('write', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
@ -468,7 +468,7 @@ $utopia->get('/v1/database/collections/:collectionId/documents')
->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER])
->label('sdk.method', 'listDocuments') ->label('sdk.method', 'listDocuments')
->label('sdk.description', '/docs/references/database/list-documents.md') ->label('sdk.description', '/docs/references/database/list-documents.md')
->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/database?platform=server#createCollection).') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/server/database#createCollection).')
->param('filters', [], function () { return new ArrayList(new Text(128)); }, 'Array of filter strings. Each filter is constructed from a key name, comparison operator (=, !=, >, <, <=, >=) and a value. You can also use a dot (.) separator in attribute names to filter by child document attributes. Examples: \'name=John Doe\' or \'category.$id>=5bed2d152c362\'.', true) ->param('filters', [], function () { return new ArrayList(new Text(128)); }, 'Array of filter strings. Each filter is constructed from a key name, comparison operator (=, !=, >, <, <=, >=) and a value. You can also use a dot (.) separator in attribute names to filter by child document attributes. Examples: \'name=John Doe\' or \'category.$id>=5bed2d152c362\'.', true)
->param('offset', 0, function () { return new Range(0, 900000000); }, 'Offset value. Use this value to manage pagination.', true) ->param('offset', 0, function () { return new Range(0, 900000000); }, 'Offset value. Use this value to manage pagination.', true)
->param('limit', 50, function () { return new Range(0, 1000); }, 'Maximum number of documents to return in response. Use this value to manage pagination.', true) ->param('limit', 50, function () { return new Range(0, 1000); }, 'Maximum number of documents to return in response. Use this value to manage pagination.', true)
@ -535,7 +535,7 @@ $utopia->get('/v1/database/collections/:collectionId/documents/:documentId')
->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER])
->label('sdk.method', 'getDocument') ->label('sdk.method', 'getDocument')
->label('sdk.description', '/docs/references/database/get-document.md') ->label('sdk.description', '/docs/references/database/get-document.md')
->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/database?platform=server#createCollection).') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/server/database#createCollection).')
->param('documentId', null, function () { return new UID(); }, 'Document unique ID.') ->param('documentId', null, function () { return new UID(); }, 'Document unique ID.')
->action( ->action(
function ($collectionId, $documentId) use ($response, $request, $projectDB, $isDev) { function ($collectionId, $documentId) use ($response, $request, $projectDB, $isDev) {
@ -581,7 +581,7 @@ $utopia->patch('/v1/database/collections/:collectionId/documents/:documentId')
->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER])
->label('sdk.method', 'updateDocument') ->label('sdk.method', 'updateDocument')
->label('sdk.description', '/docs/references/database/update-document.md') ->label('sdk.description', '/docs/references/database/update-document.md')
->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/database?platform=server#createCollection).') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/server/database#createCollection).')
->param('documentId', null, function () { return new UID(); }, 'Document unique ID.') ->param('documentId', null, function () { return new UID(); }, 'Document unique ID.')
->param('data', [], function () { return new \Utopia\Validator\Mock(); }, 'Document data as JSON object.') ->param('data', [], function () { return new \Utopia\Validator\Mock(); }, 'Document data as JSON object.')
->param('read', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.') ->param('read', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
@ -660,7 +660,7 @@ $utopia->delete('/v1/database/collections/:collectionId/documents/:documentId')
->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER])
->label('sdk.method', 'deleteDocument') ->label('sdk.method', 'deleteDocument')
->label('sdk.description', '/docs/references/database/delete-document.md') ->label('sdk.description', '/docs/references/database/delete-document.md')
->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/database?platform=server#createCollection).') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/server/database#createCollection).')
->param('documentId', null, function () { return new UID(); }, 'Document unique ID.') ->param('documentId', null, function () { return new UID(); }, 'Document unique ID.')
->action( ->action(
function ($collectionId, $documentId) use ($response, $projectDB, $audit, $webhook, $isDev) { function ($collectionId, $documentId) use ($response, $projectDB, $audit, $webhook, $isDev) {