Skip to content

Commit 66c33ea

Browse files
MiracleDevProMiracleDevPro
committed
Merge pull request #8617 from appwrite/docs-fix-endpoints
Sentence casing endpoint API reference
2 parents 8def863 + 7f0dc6d commit 66c33ea

10 files changed

Lines changed: 57 additions & 57 deletions

File tree

‎app/controllers/api/account.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3683,7 +3683,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
36833683
});
36843684

36853685
App::get('/v1/account/mfa/factors')
3686-
->desc('List Factors')
3686+
->desc('List factors')
36873687
->groups(['api', 'account', 'mfa'])
36883688
->label('scope', 'account')
36893689
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
@@ -3715,7 +3715,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
37153715
});
37163716

37173717
App::post('/v1/account/mfa/authenticators/:type')
3718-
->desc('Create Authenticator')
3718+
->desc('Create authenticator')
37193719
->groups(['api', 'account'])
37203720
->label('event', 'users.[userId].update.mfa')
37213721
->label('scope', 'account')
@@ -3787,7 +3787,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
37873787
});
37883788

37893789
App::put('/v1/account/mfa/authenticators/:type')
3790-
->desc('Verify Authenticator')
3790+
->desc('Verify authenticator')
37913791
->groups(['api', 'account'])
37923792
->label('event', 'users.[userId].update.mfa')
37933793
->label('scope', 'account')
@@ -3852,7 +3852,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
38523852
});
38533853

38543854
App::post('/v1/account/mfa/recovery-codes')
3855-
->desc('Create MFA Recovery Codes')
3855+
->desc('Create MFA recovery codes')
38563856
->groups(['api', 'account'])
38573857
->label('event', 'users.[userId].update.mfa')
38583858
->label('scope', 'account')
@@ -3894,7 +3894,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
38943894
});
38953895

38963896
App::patch('/v1/account/mfa/recovery-codes')
3897-
->desc('Regenerate MFA Recovery Codes')
3897+
->desc('Regenerate MFA recovery codes')
38983898
->groups(['api', 'account', 'mfaProtected'])
38993899
->label('event', 'users.[userId].update.mfa')
39003900
->label('scope', 'account')
@@ -3935,7 +3935,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
39353935
});
39363936

39373937
App::get('/v1/account/mfa/recovery-codes')
3938-
->desc('Get MFA Recovery Codes')
3938+
->desc('Get MFA recovery codes')
39393939
->groups(['api', 'account', 'mfaProtected'])
39403940
->label('scope', 'account')
39413941
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
@@ -3965,7 +3965,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
39653965
});
39663966

39673967
App::delete('/v1/account/mfa/authenticators/:type')
3968-
->desc('Delete Authenticator')
3968+
->desc('Delete authenticator')
39693969
->groups(['api', 'account', 'mfaProtected'])
39703970
->label('event', 'users.[userId].delete.mfa')
39713971
->label('scope', 'account')
@@ -4003,7 +4003,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
40034003
});
40044004

40054005
App::post('/v1/account/mfa/challenge')
4006-
->desc('Create MFA Challenge')
4006+
->desc('Create MFA challenge')
40074007
->groups(['api', 'account', 'mfa'])
40084008
->label('scope', 'account')
40094009
->label('event', 'users.[userId].challenges.[challengeId].create')
@@ -4191,7 +4191,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
41914191
});
41924192

41934193
App::put('/v1/account/mfa/challenge')
4194-
->desc('Create MFA Challenge (confirmation)')
4194+
->desc('Create MFA challenge (confirmation)')
41954195
->groups(['api', 'account', 'mfa'])
41964196
->label('scope', 'account')
41974197
->label('event', 'users.[userId].sessions.[sessionId].create')
@@ -4452,7 +4452,7 @@ function sendSessionAlert(Locale $locale, Document $user, Document $project, Doc
44524452
$response->noContent();
44534453
});
44544454
App::get('/v1/account/identities')
4455-
->desc('List Identities')
4455+
->desc('List identities')
44564456
->groups(['api', 'account'])
44574457
->label('scope', 'account')
44584458
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])

‎app/controllers/api/avatars.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,7 @@
550550
});
551551

552552
App::get('/v1/cards/cloud')
553-
->desc('Get Front Of Cloud Card')
553+
->desc('Get front Of Cloud Card')
554554
->groups(['api', 'avatars'])
555555
->label('scope', 'avatars.read')
556556
->label('cache', true)
@@ -757,7 +757,7 @@
757757
});
758758

759759
App::get('/v1/cards/cloud-back')
760-
->desc('Get Back Of Cloud Card')
760+
->desc('Get back Of Cloud Card')
761761
->groups(['api', 'avatars'])
762762
->label('scope', 'avatars.read')
763763
->label('cache', true)
@@ -835,7 +835,7 @@
835835
});
836836

837837
App::get('/v1/cards/cloud-og')
838-
->desc('Get OG Image From Cloud Card')
838+
->desc('Get OG image From Cloud Card')
839839
->groups(['api', 'avatars'])
840840
->label('scope', 'avatars.read')
841841
->label('cache', true)

‎app/controllers/api/console.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
});
5858

5959
App::post('/v1/console/assistant')
60-
->desc('Ask Query')
60+
->desc('Ask query')
6161
->groups(['api', 'assistant'])
6262
->label('scope', 'assistant.read')
6363
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])

‎app/controllers/api/locale.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
});
7070

7171
App::get('/v1/locale/codes')
72-
->desc('List Locale Codes')
72+
->desc('List locale codes')
7373
->groups(['api', 'locale'])
7474
->label('scope', 'locale.read')
7575
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])

‎app/controllers/api/migrations.php‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
App::post('/v1/migrations/appwrite')
3535
->groups(['api', 'migrations'])
36-
->desc('Migrate Appwrite Data')
36+
->desc('Migrate Appwrite data')
3737
->label('scope', 'migrations.write')
3838
->label('event', 'migrations.[migrationId].create')
3939
->label('audits.event', 'migration.create')
@@ -87,7 +87,7 @@
8787

8888
App::post('/v1/migrations/firebase/oauth')
8989
->groups(['api', 'migrations'])
90-
->desc('Migrate Firebase Data (OAuth)')
90+
->desc('Migrate Firebase data (OAuth)')
9191
->label('scope', 'migrations.write')
9292
->label('event', 'migrations.[migrationId].create')
9393
->label('audits.event', 'migration.create')
@@ -189,7 +189,7 @@
189189

190190
App::post('/v1/migrations/firebase')
191191
->groups(['api', 'migrations'])
192-
->desc('Migrate Firebase Data (Service Account)')
192+
->desc('Migrate Firebase data (Service Account)')
193193
->label('scope', 'migrations.write')
194194
->label('event', 'migrations.[migrationId].create')
195195
->label('audits.event', 'migration.create')
@@ -249,7 +249,7 @@
249249

250250
App::post('/v1/migrations/supabase')
251251
->groups(['api', 'migrations'])
252-
->desc('Migrate Supabase Data')
252+
->desc('Migrate Supabase data')
253253
->label('scope', 'migrations.write')
254254
->label('event', 'migrations.[migrationId].create')
255255
->label('audits.event', 'migration.create')
@@ -309,7 +309,7 @@
309309

310310
App::post('/v1/migrations/nhost')
311311
->groups(['api', 'migrations'])
312-
->desc('Migrate NHost Data')
312+
->desc('Migrate NHost data')
313313
->label('scope', 'migrations.write')
314314
->label('event', 'migrations.[migrationId].create')
315315
->label('audits.event', 'migration.create')
@@ -371,7 +371,7 @@
371371

372372
App::get('/v1/migrations')
373373
->groups(['api', 'migrations'])
374-
->desc('List Migrations')
374+
->desc('List migrations')
375375
->label('scope', 'migrations.read')
376376
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
377377
->label('sdk.namespace', 'migrations')
@@ -424,7 +424,7 @@
424424

425425
App::get('/v1/migrations/:migrationId')
426426
->groups(['api', 'migrations'])
427-
->desc('Get Migration')
427+
->desc('Get migration')
428428
->label('scope', 'migrations.read')
429429
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
430430
->label('sdk.namespace', 'migrations')
@@ -448,7 +448,7 @@
448448

449449
App::get('/v1/migrations/appwrite/report')
450450
->groups(['api', 'migrations'])
451-
->desc('Generate a report on Appwrite Data')
451+
->desc('Generate a report on Appwrite data')
452452
->label('scope', 'migrations.write')
453453
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
454454
->label('sdk.namespace', 'migrations')
@@ -490,7 +490,7 @@
490490

491491
App::get('/v1/migrations/firebase/report')
492492
->groups(['api', 'migrations'])
493-
->desc('Generate a report on Firebase Data')
493+
->desc('Generate a report on Firebase data')
494494
->label('scope', 'migrations.write')
495495
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
496496
->label('sdk.namespace', 'migrations')
@@ -537,7 +537,7 @@
537537

538538
App::get('/v1/migrations/firebase/report/oauth')
539539
->groups(['api', 'migrations'])
540-
->desc('Generate a report on Firebase Data using OAuth')
540+
->desc('Generate a report on Firebase data using OAuth')
541541
->label('scope', 'migrations.write')
542542
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
543543
->label('sdk.namespace', 'migrations')
@@ -627,7 +627,7 @@
627627
});
628628

629629
App::get('/v1/migrations/firebase/connect')
630-
->desc('Authorize with firebase')
630+
->desc('Authorize with Firebase')
631631
->groups(['api', 'migrations'])
632632
->label('scope', 'migrations.write')
633633
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@@ -781,7 +781,7 @@
781781
});
782782

783783
App::get('/v1/migrations/firebase/projects')
784-
->desc('List Firebase Projects')
784+
->desc('List Firebase projects')
785785
->groups(['api', 'migrations'])
786786
->label('scope', 'migrations.read')
787787
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@@ -870,7 +870,7 @@
870870
});
871871

872872
App::get('/v1/migrations/firebase/deauthorize')
873-
->desc('Revoke Appwrite\'s authorization to access Firebase Projects')
873+
->desc('Revoke Appwrite\'s authorization to access Firebase projects')
874874
->groups(['api', 'migrations'])
875875
->label('scope', 'migrations.write')
876876
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@@ -985,7 +985,7 @@
985985

986986
App::patch('/v1/migrations/:migrationId')
987987
->groups(['api', 'migrations'])
988-
->desc('Retry Migration')
988+
->desc('Retry migration')
989989
->label('scope', 'migrations.write')
990990
->label('event', 'migrations.[migrationId].retry')
991991
->label('audits.event', 'migration.retry')
@@ -1030,7 +1030,7 @@
10301030

10311031
App::delete('/v1/migrations/:migrationId')
10321032
->groups(['api', 'migrations'])
1033-
->desc('Delete Migration')
1033+
->desc('Delete migration')
10341034
->label('scope', 'migrations.write')
10351035
->label('event', 'migrations.[migrationId].delete')
10361036
->label('audits.event', 'migrationId.delete')

‎app/controllers/api/project.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@
288288

289289
// Variables
290290
App::post('/v1/project/variables')
291-
->desc('Create Variable')
291+
->desc('Create variable')
292292
->groups(['api'])
293293
->label('scope', 'projects.write')
294294
->label('audits.event', 'variable.create')
@@ -343,7 +343,7 @@
343343
});
344344

345345
App::get('/v1/project/variables')
346-
->desc('List Variables')
346+
->desc('List variables')
347347
->groups(['api'])
348348
->label('scope', 'projects.read')
349349
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@@ -368,7 +368,7 @@
368368
});
369369

370370
App::get('/v1/project/variables/:variableId')
371-
->desc('Get Variable')
371+
->desc('Get variable')
372372
->groups(['api'])
373373
->label('scope', 'projects.read')
374374
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@@ -392,7 +392,7 @@
392392
});
393393

394394
App::put('/v1/project/variables/:variableId')
395-
->desc('Update Variable')
395+
->desc('Update variable')
396396
->groups(['api'])
397397
->label('scope', 'projects.write')
398398
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@@ -438,7 +438,7 @@
438438
});
439439

440440
App::delete('/v1/project/variables/:variableId')
441-
->desc('Delete Variable')
441+
->desc('Delete variable')
442442
->groups(['api'])
443443
->label('scope', 'projects.write')
444444
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])

‎app/controllers/api/proxy.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
App::post('/v1/proxy/rules')
2525
->groups(['api', 'proxy'])
26-
->desc('Create Rule')
26+
->desc('Create rule')
2727
->label('scope', 'rules.write')
2828
->label('event', 'rules.[ruleId].create')
2929
->label('audits.event', 'rule.create')
@@ -149,7 +149,7 @@
149149

150150
App::get('/v1/proxy/rules')
151151
->groups(['api', 'proxy'])
152-
->desc('List Rules')
152+
->desc('List rules')
153153
->label('scope', 'rules.read')
154154
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
155155
->label('sdk.namespace', 'proxy')
@@ -212,7 +212,7 @@
212212

213213
App::get('/v1/proxy/rules/:ruleId')
214214
->groups(['api', 'proxy'])
215-
->desc('Get Rule')
215+
->desc('Get rule')
216216
->label('scope', 'rules.read')
217217
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
218218
->label('sdk.namespace', 'proxy')
@@ -241,7 +241,7 @@
241241

242242
App::delete('/v1/proxy/rules/:ruleId')
243243
->groups(['api', 'proxy'])
244-
->desc('Delete Rule')
244+
->desc('Delete rule')
245245
->label('scope', 'rules.write')
246246
->label('event', 'rules.[ruleId].delete')
247247
->label('audits.event', 'rules.delete')
@@ -277,7 +277,7 @@
277277
});
278278

279279
App::patch('/v1/proxy/rules/:ruleId/verification')
280-
->desc('Update Rule Verification Status')
280+
->desc('Update rule verification status')
281281
->groups(['api', 'proxy'])
282282
->label('scope', 'rules.write')
283283
->label('event', 'rules.[ruleId].update')

‎app/controllers/api/storage.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1549,7 +1549,7 @@
15491549
});
15501550

15511551
App::delete('/v1/storage/buckets/:bucketId/files/:fileId')
1552-
->desc('Delete File')
1552+
->desc('Delete file')
15531553
->groups(['api', 'storage'])
15541554
->label('scope', 'files.write')
15551555
->label('event', 'buckets.[bucketId].files.[fileId].delete')

0 commit comments

Comments
 (0)