From 8ea97061747dfdb373849a31654f209db6eb4da0 Mon Sep 17 00:00:00 2001
From: loks0n <22452787+loks0n@users.noreply.github.com>
Date: Thu, 30 Nov 2023 11:35:52 +0000
Subject: [PATCH] feat: Matej renaming plan

---
 app/controllers/api/account.php               | 27 ++++++++++---------
 app/controllers/api/users.php                 |  8 +++---
 ...onymous.md => create-anonymous-session.md} |  0
 ...ssion-email.md => create-email-session.md} |  0
 ...l-session.md => create-magic-url-token.md} |  0
 ...phone-session.md => create-phone-token.md} |  0
 ...tom-session.md => create-token-session.md} |  0
 .../account/update-magic-url-session.md       |  3 ---
 .../account/update-phone-session.md           |  1 -
 ...eate-custom-session.md => create-token.md} |  0
 .../Account/AccountCustomClientTest.php       | 12 ++++-----
 .../Account/AccountCustomServerTest.php       |  2 +-
 tests/e2e/Services/Users/UsersBase.php        |  6 ++---
 13 files changed, 29 insertions(+), 30 deletions(-)
 rename docs/references/account/{create-session-anonymous.md => create-anonymous-session.md} (100%)
 rename docs/references/account/{create-session-email.md => create-email-session.md} (100%)
 rename docs/references/account/{create-magic-url-session.md => create-magic-url-token.md} (100%)
 rename docs/references/account/{create-phone-session.md => create-phone-token.md} (100%)
 rename docs/references/account/{update-custom-session.md => create-token-session.md} (100%)
 delete mode 100644 docs/references/account/update-magic-url-session.md
 delete mode 100644 docs/references/account/update-phone-session.md
 rename docs/references/users/{create-custom-session.md => create-token.md} (100%)

diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php
index 1f9ade2cd..00df55406 100644
--- a/app/controllers/api/account.php
+++ b/app/controllers/api/account.php
@@ -897,8 +897,9 @@ App::delete('/v1/account/identities/:identityId')
         return $response->noContent();
     });
 
-App::post('/v1/account/sessions/magic-url')
-    ->desc('Create magic URL session')
+App::post('/v1/account/tokens/magic-url')
+    ->alias('/v1/account/sessions/magic-url')
+    ->desc('Create magic URL token')
     ->groups(['api', 'account'])
     ->label('scope', 'sessions')
     ->label('auth.type', 'magic-url')
@@ -907,8 +908,8 @@ App::post('/v1/account/sessions/magic-url')
     ->label('audits.userId', '{response.userId}')
     ->label('sdk.auth', [])
     ->label('sdk.namespace', 'account')
-    ->label('sdk.method', 'createMagicURLSession')
-    ->label('sdk.description', '/docs/references/account/create-magic-url-session.md')
+    ->label('sdk.method', 'createMagicURLToken')
+    ->label('sdk.description', '/docs/references/account/create-magic-url-token.md')
     ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_TOKEN)
@@ -1111,10 +1112,11 @@ App::post('/v1/account/sessions/magic-url')
         ;
     });
 
-App::put('/v1/account/sessions/custom')
+App::put('/v1/account/sessions/token')
     ->alias('/v1/account/sessions/magic-url')
     ->alias('/v1/account/sessions/phone')
-    ->desc('Update custom session')
+    ->desc('Exchange token for session')
+    ->label('event', 'users.[userId].sessions.[sessionId].create')
     ->groups(['api', 'account'])
     ->label('scope', 'sessions')
     ->label('auth.type', 'token')
@@ -1124,8 +1126,8 @@ App::put('/v1/account/sessions/custom')
     ->label('usage.metric', 'sessions.{scope}.requests.create')
     ->label('sdk.auth', [])
     ->label('sdk.namespace', 'account')
-    ->label('sdk.method', 'updateSessionToken')
-    ->label('sdk.description', '/docs/references/account/update-custom-session.md')
+    ->label('sdk.method', 'exchangeTokenForSession')
+    ->label('sdk.description', '/docs/references/account/exchange-token-for-session.md')
     ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_SESSION)
@@ -1237,8 +1239,9 @@ App::put('/v1/account/sessions/custom')
         $response->dynamic($session, Response::MODEL_SESSION);
     });
 
-App::post('/v1/account/sessions/phone')
-    ->desc('Create phone session')
+App::post('/v1/account/tokens/phone')
+    ->alias('/v1/account/sessions/phone')
+    ->desc('Create phone token')
     ->groups(['api', 'account'])
     ->label('scope', 'sessions')
     ->label('auth.type', 'phone')
@@ -1247,8 +1250,8 @@ App::post('/v1/account/sessions/phone')
     ->label('audits.userId', '{response.userId}')
     ->label('sdk.auth', [])
     ->label('sdk.namespace', 'account')
-    ->label('sdk.method', 'createPhoneSession')
-    ->label('sdk.description', '/docs/references/account/create-phone-session.md')
+    ->label('sdk.method', 'createPhoneToken')
+    ->label('sdk.description', '/docs/references/account/create-phone-token.md')
     ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_TOKEN)
diff --git a/app/controllers/api/users.php b/app/controllers/api/users.php
index cd8971edc..72c11d2a7 100644
--- a/app/controllers/api/users.php
+++ b/app/controllers/api/users.php
@@ -1081,8 +1081,8 @@ App::patch('/v1/users/:userId/prefs')
         $response->dynamic(new Document($prefs), Response::MODEL_PREFERENCES);
     });
 
-App::post('/v1/users/:userId/sessions')
-    ->desc('Create custom session')
+App::post('/v1/users/:userId/tokens')
+    ->desc('Create token')
     ->groups(['api', 'users'])
     ->label('event', 'users.[userId].tokens.create')
     ->label('scope', 'users.write')
@@ -1091,8 +1091,8 @@ App::post('/v1/users/:userId/sessions')
     ->label('usage.metric', 'tokens.requests.create')
     ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
     ->label('sdk.namespace', 'users')
-    ->label('sdk.method', 'createCustomSession')
-    ->label('sdk.description', '/docs/references/users/create-custom-session.md')
+    ->label('sdk.method', 'createToken')
+    ->label('sdk.description', '/docs/references/users/create-token.md')
     ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_TOKEN)
diff --git a/docs/references/account/create-session-anonymous.md b/docs/references/account/create-anonymous-session.md
similarity index 100%
rename from docs/references/account/create-session-anonymous.md
rename to docs/references/account/create-anonymous-session.md
diff --git a/docs/references/account/create-session-email.md b/docs/references/account/create-email-session.md
similarity index 100%
rename from docs/references/account/create-session-email.md
rename to docs/references/account/create-email-session.md
diff --git a/docs/references/account/create-magic-url-session.md b/docs/references/account/create-magic-url-token.md
similarity index 100%
rename from docs/references/account/create-magic-url-session.md
rename to docs/references/account/create-magic-url-token.md
diff --git a/docs/references/account/create-phone-session.md b/docs/references/account/create-phone-token.md
similarity index 100%
rename from docs/references/account/create-phone-session.md
rename to docs/references/account/create-phone-token.md
diff --git a/docs/references/account/update-custom-session.md b/docs/references/account/create-token-session.md
similarity index 100%
rename from docs/references/account/update-custom-session.md
rename to docs/references/account/create-token-session.md
diff --git a/docs/references/account/update-magic-url-session.md b/docs/references/account/update-magic-url-session.md
deleted file mode 100644
index b4ace4592..000000000
--- a/docs/references/account/update-magic-url-session.md
+++ /dev/null
@@ -1,3 +0,0 @@
-Use this endpoint to complete creating the session with the Magic URL. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#createMagicURLSession) endpoint.
-
-Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
\ No newline at end of file
diff --git a/docs/references/account/update-phone-session.md b/docs/references/account/update-phone-session.md
deleted file mode 100644
index e57ce5e41..000000000
--- a/docs/references/account/update-phone-session.md
+++ /dev/null
@@ -1 +0,0 @@
-Use this endpoint to complete creating a session with SMS. Use the **userId** from the [createPhoneSession](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneSession) endpoint and the **secret** received via SMS to successfully update and confirm the phone session.
\ No newline at end of file
diff --git a/docs/references/users/create-custom-session.md b/docs/references/users/create-token.md
similarity index 100%
rename from docs/references/users/create-custom-session.md
rename to docs/references/users/create-token.md
diff --git a/tests/e2e/Services/Account/AccountCustomClientTest.php b/tests/e2e/Services/Account/AccountCustomClientTest.php
index ca679fa0a..519d63424 100644
--- a/tests/e2e/Services/Account/AccountCustomClientTest.php
+++ b/tests/e2e/Services/Account/AccountCustomClientTest.php
@@ -1936,7 +1936,7 @@ class AccountCustomClientTest extends Scope
         /**
          * Test for SUCCESS
          */
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/phone', array_merge([
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/phone', array_merge([
             'origin' => 'http://localhost',
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
@@ -1955,7 +1955,7 @@ class AccountCustomClientTest extends Scope
         /**
          * Test for FAILURE
          */
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/phone', array_merge([
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/phone', array_merge([
             'origin' => 'http://localhost',
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
@@ -2325,7 +2325,7 @@ class AccountCustomClientTest extends Scope
         /**
          * Test for SUCCESS
          */
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/magic-url', array_merge([
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/magic-url', array_merge([
             'origin' => 'http://localhost',
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
@@ -2363,7 +2363,7 @@ class AccountCustomClientTest extends Scope
         /**
          * Test for FAILURE
          */
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/magic-url', array_merge([
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/magic-url', array_merge([
             'origin' => 'http://localhost',
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
@@ -2375,7 +2375,7 @@ class AccountCustomClientTest extends Scope
 
         $this->assertEquals(400, $response['headers']['status-code']);
 
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/magic-url', array_merge([
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/magic-url', array_merge([
             'origin' => 'http://localhost',
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
@@ -2387,7 +2387,7 @@ class AccountCustomClientTest extends Scope
 
         $this->assertEquals(400, $response['headers']['status-code']);
 
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/magic-url', array_merge([
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/magic-url', array_merge([
             'origin' => 'http://localhost',
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
diff --git a/tests/e2e/Services/Account/AccountCustomServerTest.php b/tests/e2e/Services/Account/AccountCustomServerTest.php
index b6e3eab6e..cf563affa 100644
--- a/tests/e2e/Services/Account/AccountCustomServerTest.php
+++ b/tests/e2e/Services/Account/AccountCustomServerTest.php
@@ -58,7 +58,7 @@ class AccountCustomServerTest extends Scope
         /**
          * Test for SUCCESS
          */
-        $response = $this->client->call(Client::METHOD_POST, '/account/sessions/magic-url', array_merge(
+        $response = $this->client->call(Client::METHOD_POST, '/account/tokens/magic-url', array_merge(
             [
                 'content-type' => 'application/json',
                 'x-appwrite-project' => $this->getProject()['$id']
diff --git a/tests/e2e/Services/Users/UsersBase.php b/tests/e2e/Services/Users/UsersBase.php
index af811b3fb..250827df3 100644
--- a/tests/e2e/Services/Users/UsersBase.php
+++ b/tests/e2e/Services/Users/UsersBase.php
@@ -232,12 +232,12 @@ trait UsersBase
     /**
      * @depends testCreateUser
      */
-    public function testCreateCustomSession(array $data): void
+    public function testCreateToken(array $data): void
     {
         /**
          * Test for SUCCESS
          */
-        $token = $this->client->call(Client::METHOD_POST, '/users/' . $data['userId'] . '/sessions', array_merge([
+        $token = $this->client->call(Client::METHOD_POST, '/users/' . $data['userId'] . '/tokens', array_merge([
             'x-appwrite-project' => $this->getProject()['$id'],
         ], $this->getHeaders()), [
             'expire' => 60,
@@ -251,7 +251,7 @@ trait UsersBase
         /**
          * Test for FAILURE
          */
-        $token = $this->client->call(Client::METHOD_POST, '/users/invalid/sessions', array_merge([
+        $token = $this->client->call(Client::METHOD_POST, '/users/invalid/tokens', array_merge([
             'x-appwrite-project' => $this->getProject()['$id'],
         ], $this->getHeaders()));