docs: add descriptions to universal token endpoints

This commit is contained in:
loks0n committed 2023-10-11 16:31:32 +01:00
1 parent 4f11cbacb4
commit f9d6ebd3a0
4 files changed
+6 -4

No files matched your search

+3 -3
View File
@@ -1111,7 +1111,7 @@ App::post('/v1/account/sessions/magic-url')
});
App::put('/v1/account/sessions/token')
->desc('Exchange token for session')
->desc('Update universal token session')
->groups(['api', 'account'])
->label('scope', 'public')
->label('auth.type', 'token')
@@ -1121,8 +1121,8 @@ App::put('/v1/account/sessions/token')
->label('usage.metric', 'sessions.{scope}.requests.create')
->label('sdk.auth', [])
->label('sdk.namespace', 'account')
->label('sdk.method', 'createTokenSession')
->label('sdk.description', '/docs/references/account/create-token-session.md')
->label('sdk.method', 'exchangeTokenForSession')
->label('sdk.description', '/docs/references/account/update-universal-token-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)
+1 -1
View File
@@ -1092,7 +1092,7 @@ App::post('/v1/users/:userId/tokens')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'users')
->label('sdk.method', 'createToken')
->label('sdk.description', '/docs/references/users/create-user-token.md')
->label('sdk.description', '/docs/references/users/create-universal-token-session.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TOKEN)
@@ -0,0 +1 @@
Use this endpoint to exchange a previously generated 'universal' token for a session. The returned session will be a regular session object with all its own credentials and metadata.
@@ -0,0 +1 @@
Use this endpoint to generate a 'universal' token which can be sent to a user by a secure method, and then exchanged for a session.