CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-06-02 02:44:47 +12:00
Code Issues Projects Releases Wiki Activity

Add API Descriptions and use APP_LIMIT_COUNT

Browse source
This commit is contained in:
Bradley Schofield 2022-08-09 13:11:50 +01:00
parent af0c111d2e
commit d4da9d823b
6 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
app/controllers/api/functions.php
View file

@ -910,7 +910,7 @@ App::post('/v1/functions/:functionId/executions')
$variables = $dbForProject->find('variables', [
new Query('functionInternalId', Query::TYPE_EQUAL, [$function->getInternalId()]),
], 5000);
], APP_LIMIT_COUNT);
$vars = \array_merge($variables, [
'APPWRITE_FUNCTION_ID' => $function->getId(),
@ -1124,6 +1124,7 @@ App::post('/v1/functions/:functionId/variables/')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions')
->label('sdk.method', 'createVariable')
->label('sdk.description', '/docs/references/functions/create-variable.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_VARIABLE)
@ -1168,6 +1169,7 @@ App::get('/v1/functions/:functionId/variables/')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions')
->label('sdk.method', 'listVariables')
->label('sdk.description', '/docs/references/functions/list-variables.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_VARIABLE_LIST)
@ -1199,6 +1201,7 @@ App::get('/v1/functions/:functionId/variables//:variableId')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions')
->label('sdk.method', 'getVariable')
->label('sdk.description', '/docs/references/functions/get-variable.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_VARIABLE)
@ -1232,6 +1235,7 @@ App::put('/v1/functions/:functionId/variables//:variableId')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions')
->label('sdk.method', 'updateVariable')
->label('sdk.description', '/docs/references/functions/update-variable.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_VARIABLE)
@ -1284,6 +1288,7 @@ App::delete('/v1/functions/:functionId/variables//:variableId')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions')
->label('sdk.method', 'deleteVariable')
->label('sdk.description', '/docs/references/functions/delete-variable.md')
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
->label('sdk.response.model', Response::MODEL_NONE)
->param('functionId', null, new UID(), 'Function unique ID.', false)

1
docs/references/functions/create-variable.md Normal file
View file

@ -0,0 +1 @@
Create a new function variable. These variables can be accessed within functions using the `env` object recieved through the payload of an execution.

1
docs/references/functions/delete-variable.md Normal file
View file

@ -0,0 +1 @@
Delete a variable by its unique ID.

1
docs/references/functions/get-variable.md Normal file
View file

@ -0,0 +1 @@
Get a variable by its unique ID.

1
docs/references/functions/list-variables.md Normal file
View file

@ -0,0 +1 @@
Get a list of all variables that are currently active on your function.

1
docs/references/functions/update-variable.md Normal file
View file

@ -0,0 +1 @@
Update variable by its unique ID.