From d488cadee494390a3fbe087f5b86b9a8e17089b2 Mon Sep 17 00:00:00 2001 From: loks0n <22452787+loks0n@users.noreply.github.com> Date: Tue, 16 Jan 2024 10:33:54 +0000 Subject: [PATCH] docs: verb noun desc file pattern --- app/controllers/api/account.php | 8 ++++---- ...e-anonymous-session.md => create-session-anonymous.md} | 0 ...ssword-session.md => create-session-email-password.md} | 0 ...{create-oauth2-session.md => create-session-oauth2.md} | 0 ...reate-magic-url-token.md => create-token-magic-url.md} | 0 .../{create-phone-token.md => create-token-phone.md} | 0 6 files changed, 4 insertions(+), 4 deletions(-) rename docs/references/account/{create-anonymous-session.md => create-session-anonymous.md} (100%) rename docs/references/account/{create-email-password-session.md => create-session-email-password.md} (100%) rename docs/references/account/{create-oauth2-session.md => create-session-oauth2.md} (100%) rename docs/references/account/{create-magic-url-token.md => create-token-magic-url.md} (100%) rename docs/references/account/{create-phone-token.md => create-token-phone.md} (100%) diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index dea25cb605..c07651b75a 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -196,7 +196,7 @@ App::post('/v1/account/sessions/email') ->label('sdk.auth', []) ->label('sdk.namespace', 'account') ->label('sdk.method', ['createEmailPasswordSession', 'createEmailSession']) - ->label('sdk.description', '/docs/references/account/create-email-password-session.md') + ->label('sdk.description', '/docs/references/account/create-session-email-password.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_SESSION) @@ -315,7 +315,7 @@ App::get('/v1/account/sessions/oauth2/:provider') ->label('sdk.hideServer', true) ->label('sdk.namespace', 'account') ->label('sdk.method', 'createOAuth2Session') - ->label('sdk.description', '/docs/references/account/create-oauth2-session.md') + ->label('sdk.description', '/docs/references/account/create-session-oauth2.md') ->label('sdk.response.code', Response::STATUS_CODE_MOVED_PERMANENTLY) ->label('sdk.response.type', Response::CONTENT_TYPE_HTML) ->label('sdk.methodType', 'webAuth') @@ -974,7 +974,7 @@ App::post('/v1/account/tokens/magic-url') ->label('sdk.auth', []) ->label('sdk.namespace', 'account') ->label('sdk.method', ['createMagicURLToken', 'createMagicURLSession']) - ->label('sdk.description', '/docs/references/account/create-magic-url-token.md') + ->label('sdk.description', '/docs/references/account/create-token-magic-url.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_TOKEN) @@ -1376,7 +1376,7 @@ App::post('/v1/account/tokens/phone') ->label('sdk.auth', []) ->label('sdk.namespace', 'account') ->label('sdk.method', ['createPhoneToken', 'createPhoneSession']) - ->label('sdk.description', '/docs/references/account/create-phone-token.md') + ->label('sdk.description', '/docs/references/account/create-token-phone.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-anonymous-session.md b/docs/references/account/create-session-anonymous.md similarity index 100% rename from docs/references/account/create-anonymous-session.md rename to docs/references/account/create-session-anonymous.md diff --git a/docs/references/account/create-email-password-session.md b/docs/references/account/create-session-email-password.md similarity index 100% rename from docs/references/account/create-email-password-session.md rename to docs/references/account/create-session-email-password.md diff --git a/docs/references/account/create-oauth2-session.md b/docs/references/account/create-session-oauth2.md similarity index 100% rename from docs/references/account/create-oauth2-session.md rename to docs/references/account/create-session-oauth2.md diff --git a/docs/references/account/create-magic-url-token.md b/docs/references/account/create-token-magic-url.md similarity index 100% rename from docs/references/account/create-magic-url-token.md rename to docs/references/account/create-token-magic-url.md diff --git a/docs/references/account/create-phone-token.md b/docs/references/account/create-token-phone.md similarity index 100% rename from docs/references/account/create-phone-token.md rename to docs/references/account/create-token-phone.md