Clarification and tweaks

Room ID namespace clarifications and s/as_token/access_token/g for client-server extensions.
pull/977/head
Kegsay 10 years ago
parent d4ea43d2b9
commit 7d56113b4f

@ -33,7 +33,7 @@ Notes:
"irc\.freenode\.net/.*", "irc\.freenode\.net/.*",
] ]
The sigil prefix ``@`` is omitted since it is clear from the ``users`` key that these namespace The sigil prefix ``@`` is omitted since it is clear from the ``users`` key that these namespace
prefixes are for users. prefixes are for users. Likewise, ``#`` for ``aliases`` and ``!`` for ``rooms``.
:: ::
POST /register POST /register
@ -48,6 +48,9 @@ Notes:
], ],
aliases: [ aliases: [
"irc\.freenode\.net/.*" "irc\.freenode\.net/.*"
],
rooms: [
"irc\.freenode\.net/.*"
] ]
} }
} }
@ -167,23 +170,26 @@ acting on behalf of. For real users, this would require additional permissions (
"C-AS Linking"). "C-AS Linking").
Inputs: Inputs:
- Application service token (``as_token``) - Application service token (``access_token``)
Either: Either:
- User ID in the AS namespace to act as. - User ID in the AS namespace to act as.
Or: Or:
- OAuth2 token of real user (which may end up being an access token) - OAuth2 token of real user (which may end up being an access token)
Notes: Notes:
- This will apply on all aspects of the CS API, except for Account Management. - This will apply on all aspects of the CS API, except for Account Management.
- The ``as_token`` is inserted into ``access_token`` which is usually where the client
token is. This is done on purpose to allow application services to reuse client
SDKs.
:: ::
/path?as_token=$token&user_id=$userid /path?access_token=$token&user_id=$userid
Query Parameters: Query Parameters:
as_token: The application service token as_token: The application service token
user_id: The desired user ID to act as. user_id: The desired user ID to act as.
/path?as_token=$token&user_token=$token /path?access_token=$token&user_token=$token
Query Parameters: Query Parameters:
as_token: The application service token as_token: The application service token

Loading…
Cancel
Save