Updated docs
This commit is contained in:
eldadfux
parent
626d1bc7c7
commit
704ad23343
|
|
@ -95,8 +95,8 @@ $utopia->post('/v1/database')
|
|||
->label('sdk.method', 'createCollection')
|
||||
->label('sdk.description', 'Create a new Collection.')
|
||||
->param('name', '', function () {return new Text(256);}, 'Collection name.')
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('rules', [], function () use ($projectDB) {return new ArrayList(new Collection($projectDB, [Database::SYSTEM_COLLECTION_RULES], ['$collection' => Database::SYSTEM_COLLECTION_RULES, '$permissions' => ['read' => [], 'write' => []]]));}, 'Array of [rule objects](/docs/rules). Each rule define a collection field name, data type and validation', true)
|
||||
->action(
|
||||
function ($name, $read, $write, $rules) use ($response, $projectDB, $webhook, $audit) {
|
||||
|
|
@ -163,8 +163,8 @@ $utopia->put('/v1/database/:collectionId')
|
|||
->label('sdk.description', 'Update collection by its unique ID.')
|
||||
->param('collectionId', '', function () {return new UID();}, 'Collection unique ID.')
|
||||
->param('name', null, function () {return new Text(256);}, 'Collection name.')
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('rules', [], function () use ($projectDB) {return new ArrayList(new Collection($projectDB, [Database::SYSTEM_COLLECTION_RULES], ['$collection' => Database::SYSTEM_COLLECTION_RULES, '$permissions' => ['read' => [], 'write' => []]]));}, 'Array of [rule objects](/docs/rules). Each rule define a collection field name, data type and validation', true)
|
||||
->action(
|
||||
function ($collectionId, $name, $read, $write, $rules) use ($response, $projectDB) {
|
||||
|
|
@ -353,8 +353,8 @@ $utopia->post('/v1/database/:collectionId/documents')
|
|||
->label('sdk.description', 'Create a new Document.')
|
||||
->param('collectionId', null, function () {return new UID();}, 'Collection unique ID.')
|
||||
->param('data', [], function () {return new \Utopia\Validator\Mock();}, 'Document data as JSON string.')
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('parentDocument', '', function () {return new UID();}, 'Parent document unique ID. Use when you want your new document to be a child of a parent document.', true)
|
||||
->param('parentProperty', '', function () {return new Key();}, 'Parent document property name. Use when you want your new document to be a child of a parent document.', true)
|
||||
->param('parentPropertyType', Document::SET_TYPE_ASSIGN, function () {return new WhiteList([Document::SET_TYPE_ASSIGN, Document::SET_TYPE_APPEND, Document::SET_TYPE_PREPEND]);}, 'Parent document property connection type. You can set this value to **assign**, **append** or **prepend**, default value is assign. Use when you want your new document to be a child of a parent document.', true)
|
||||
|
|
@ -457,8 +457,8 @@ $utopia->patch('/v1/database/:collectionId/documents/:documentId')
|
|||
->param('collectionId', null, function () {return new UID();}, 'Collection unique ID')
|
||||
->param('documentId', null, function () {return new UID();}, 'Document unique ID')
|
||||
->param('data', [], function () {return new \Utopia\Validator\Mock();}, 'Document data as JSON string')
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->action(
|
||||
function ($collectionId, $documentId, $data, $read, $write) use ($response, $projectDB, &$output, $webhook, $audit, $isDev) {
|
||||
$collection = $projectDB->getDocument($collectionId/*, $isDev*/);
|
||||
|
|
|
|||
|
|
@ -401,8 +401,8 @@ $utopia->post('/v1/storage/files')
|
|||
->label('sdk.description', 'Create a new file. The user who creates the file will automatically be assigned to read and write access unless he has passed custom values for read and write arguments.')
|
||||
->label('sdk.consumes', 'multipart/form-data')
|
||||
->param('files', [], function () {return new File();}, 'Binary Files.', false)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('folderId', '', function () {return new UID();}, 'Folder to associate files with.', true)
|
||||
->action(
|
||||
function ($files, $read, $write, $folderId) use ($request, $response, $user, $projectDB, $audit, $usage) {
|
||||
|
|
@ -523,8 +523,8 @@ $utopia->put('/v1/storage/files/:fileId')
|
|||
->label('sdk.method', 'updateFile')
|
||||
->label('sdk.description', 'Update file by its unique ID. Only users with write permissions have access to update this resource.')
|
||||
->param('fileId', '', function () {return new UID();}, 'File unique ID.')
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('read', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with read permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('write', [], function () {return new ArrayList(new Text(64));}, 'An array of strings with write permissions. [Learn more about permissions and roles](/docs/permissions).', true)
|
||||
->param('folderId', '', function () {return new UID();}, 'Folder to associate files with.', true)
|
||||
->action(
|
||||
function ($fileId, $read, $write, $folderId) use ($response, $projectDB) {
|
||||
|
|
|
|||
Loading…
Reference in a new issue