CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-06-28 19:20:25 +12:00
Code Issues Projects Releases Wiki Activity

Use labels parameters to add extra methods to spec

Browse source
This commit is contained in:
Jake Barnby 2022-07-20 01:28:47 +12:00
parent c05c759eac
commit 8320fc0686
2 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
app/controllers/api/graphql.php
View file

@ -22,12 +22,12 @@ App::get('/v1/graphql')
->label('sdk.namespace', 'graphql')
->label('sdk.method', 'query')
->label('sdk.description', '/docs/references/graphql/query.md')
->label('sdk.parameters', ['query' => ['default' => '', 'validator' => new JSON(), 'description' => 'The query or queries to execute.', 'optional' => false]])
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_ANY)
->label('abuse-limit', 60)
->label('abuse-time', 60)
->param('query', '', new JSON(), 'The query or queries to execute.', fullBody: true)
->inject('request')
->inject('response')
->inject('promiseAdapter')
@ -42,12 +42,12 @@ App::post('/v1/graphql')
->label('sdk.namespace', 'graphql')
->label('sdk.method', 'mutate')
->label('sdk.description', '/docs/references/graphql/mutate.md')
->label('sdk.parameters', ['query' => ['default' => '', 'validator' => new JSON(), 'description' => 'The query or queries to execute.', 'optional' => false]])
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_ANY)
->label('abuse-limit', 60)
->label('abuse-time', 60)
->param('query', '', new JSON(), 'The query or queries to execute.', fullBody: true)
->inject('request')
->inject('response')
->inject('promiseAdapter')
@ -60,16 +60,16 @@ App::post('/v1/graphql/upload')
->label('scope', 'graphql')
->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'graphql')
->label('sdk.description', '/docs/references/graphql/upload.md')
->label('sdk.method', 'upload')
->label('sdk.description', '/docs/references/graphql/upload.md')
->label('sdk.methodType', 'upload')
->label('sdk.parameters', ['query' => ['default' => '', 'validator' => new JSON(), 'description' => 'The query or queries to execute.', 'optional' => false]])
->label('sdk.request.type', 'multipart/form-data')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_ANY)
->label('abuse-limit', 60)
->label('abuse-time', 60)
->param('query', '', new JSON(), 'The query or queries to execute.', fullBody: true)
->inject('request')
->inject('response')
->inject('promiseAdapter')
@ -80,7 +80,6 @@ App::post('/v1/graphql/upload')
/**
* Execute a GraphQL request
*
* @param array $query
* @param Request $request
* @param Response $response
* @param CoroutinePromiseAdapter $promiseAdapter
@ -89,13 +88,14 @@ App::post('/v1/graphql/upload')
* @throws Exception
*/
function executeRequest(
array $query,
Appwrite\Utopia\Request $request,
Appwrite\Utopia\Response $response,
CoroutinePromiseAdapter $promiseAdapter,
Type\Schema $schema
): void {
$query = $request->getParams();
$contentType = $request->getHeader('content-type');
$maxBatchSize = App::getEnv('_APP_GRAPHQL_MAX_BATCH_SIZE', 10);
$maxComplexity = App::getEnv('_APP_GRAPHQL_MAX_QUERY_COMPLEXITY', 50);
$maxDepth = App::getEnv('_APP_GRAPHQL_MAX_QUERY_DEPTH', 3);
@ -121,14 +121,14 @@ function executeRequest(
}
}
$debugFlags = DebugFlag::INCLUDE_DEBUG_MESSAGE | DebugFlag::INCLUDE_TRACE;
$flags = DebugFlag::INCLUDE_DEBUG_MESSAGE | DebugFlag::INCLUDE_TRACE;
$validations = GraphQL::getStandardValidationRules();
$validations[] = new QueryComplexity($maxComplexity);
$validations[] = new QueryDepth($maxDepth);
if (App::isProduction()) {
$validations[] = new DisableIntrospection();
$debugFlags = DebugFlag::NONE;
$flags = DebugFlag::NONE;
}
$promises = [];
@ -147,9 +147,9 @@ function executeRequest(
$wg = new WaitGroup();
$wg->add();
$promiseAdapter->all($promises)->then(
function (array $results) use (&$output, &$wg, $debugFlags) {
function (array $results) use (&$output, &$wg, $flags) {
try {
$output = processResult($results, $debugFlags);
$output = processResult($results, $flags);
} finally {
$wg->done();
}

7
src/Appwrite/Specification/Format/Swagger2.php
View file

@ -242,7 +242,12 @@ class Swagger2 extends Format
$bodyRequired = [];
foreach ($route->getParams() as $name => $param) { // Set params
$parameters = \array_merge(
$route->getParams(),
$route->getLabel('sdk.parameters', []),
);
foreach ($parameters as $name => $param) { // Set params
/** @var \Utopia\Validator $validator */
$validator = (\is_callable($param['validator'])) ? call_user_func_array($param['validator'], $this->app->getResources($param['injections'])) : $param['validator'];