mirror of
https://github.com/appwrite/appwrite.git
synced 2026-11-18 20:36:03 +00:00
docs(account): drop the sessionId default from its description
sessionId is a path parameter, so #13097 emits it as required and every generated SDK takes it as a mandatory argument. The description still told callers it defaults to 'current', which produced a docstring contradicting its own signature — following it raises a missing-argument error before any request: def get_session(self, session_id: str) -> Session: session_id : str Session ID. Use the string 'current' ... Defaults to 'current'. The 'current' sentinel is unchanged and still documented; only the unreachable default is.
This commit is contained in:
1 file changed
+3
-3
@@ -715,7 +715,7 @@ Http::get('/v1/account/sessions/:sessionId')
|
||||
],
|
||||
contentType: ContentType::JSON
|
||||
))
|
||||
->param('sessionId', 'current', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Session ID. Use the string \'current\' to get the current device session. Defaults to \'current\'.', true, ['dbForProject'])
|
||||
->param('sessionId', 'current', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Session ID. Use the string \'current\' to get the current device session.', true, ['dbForProject'])
|
||||
->inject('response')
|
||||
->inject('user')
|
||||
->inject('locale')
|
||||
@@ -769,7 +769,7 @@ Http::delete('/v1/account/sessions/:sessionId')
|
||||
contentType: ContentType::NONE
|
||||
))
|
||||
->label('abuse-limit', 100)
|
||||
->param('sessionId', 'current', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Session ID. Use the string \'current\' to delete the current device session. Defaults to \'current\'.', true, ['dbForProject'])
|
||||
->param('sessionId', 'current', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Session ID. Use the string \'current\' to delete the current device session.', true, ['dbForProject'])
|
||||
->inject('requestTimestamp')
|
||||
->inject('request')
|
||||
->inject('response')
|
||||
@@ -860,7 +860,7 @@ Http::patch('/v1/account/sessions/:sessionId')
|
||||
contentType: ContentType::JSON
|
||||
))
|
||||
->label('abuse-limit', 10)
|
||||
->param('sessionId', 'current', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Session ID. Use the string \'current\' to update the current device session. Defaults to \'current\'.', true, ['dbForProject'])
|
||||
->param('sessionId', 'current', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Session ID. Use the string \'current\' to update the current device session.', true, ['dbForProject'])
|
||||
->inject('response')
|
||||
->inject('user')
|
||||
->inject('dbForProject')
|
||||
|
||||
Reference in new issue
Block a user