chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add link to the matrix spec for each endpoint.

Browse Source
This commit is contained in:
Victor Berger 2016-12-23 12:12:16 +01:00
parent dadd73a158
commit a0c0890940
9 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib.rs
View File

@ -42,4 +42,6 @@ pub mod r0 {
} }
/// GET /_matrix/client/versions /// GET /_matrix/client/versions
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-versions)
pub mod supported_versions; pub mod supported_versions;

10
src/r0/account.rs
View File

@ -1,6 +1,8 @@
//! Endpoints for account registration and management. //! Endpoints for account registration and management.
/// POST /_matrix/client/r0/register /// POST /_matrix/client/r0/register
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-register)
pub mod register { pub mod register {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
@ -57,6 +59,8 @@ pub mod register {
} }
/// POST /_matrix/client/r0/account/password/email/requestToken /// POST /_matrix/client/r0/account/password/email/requestToken
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-account-password-email-requesttoken)
pub mod request_password_change_token { pub mod request_password_change_token {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
@ -91,6 +95,8 @@ pub mod request_password_change_token {
} }
/// POST /_matrix/client/r0/account/deactivate /// POST /_matrix/client/r0/account/deactivate
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-account-deactivate)
pub mod deactivate { pub mod deactivate {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;
@ -116,6 +122,8 @@ pub mod deactivate {
} }
/// POST /_matrix/client/r0/account/password /// POST /_matrix/client/r0/account/password
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-account-password)
pub mod change_password { pub mod change_password {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
@ -147,6 +155,8 @@ pub mod change_password {
} }
/// POST /_matrix/client/r0/register/email/requestToken /// POST /_matrix/client/r0/register/email/requestToken
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-register-email-requesttoken)
pub mod request_register_token { pub mod request_register_token {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]

6
src/r0/alias.rs
View File

@ -3,6 +3,8 @@
use ruma_identifiers::RoomAliasId; use ruma_identifiers::RoomAliasId;
/// PUT /_matrix/client/r0/directory/room/:room_alias /// PUT /_matrix/client/r0/directory/room/:room_alias
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-directory-room-roomalias)
pub mod create { pub mod create {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -36,6 +38,8 @@ pub mod create {
} }
/// DELETE /_matrix/client/r0/directory/room/:room_alias /// DELETE /_matrix/client/r0/directory/room/:room_alias
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#delete-matrix-client-r0-directory-room-roomalias)
pub mod delete { pub mod delete {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;
@ -61,6 +65,8 @@ pub mod delete {
} }
/// GET /_matrix/client/r0/directory/room/:room_alias /// GET /_matrix/client/r0/directory/room/:room_alias
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-directory-room-roomalias)
pub mod get { pub mod get {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;

4
src/r0/config.rs
View File

@ -1,6 +1,8 @@
//! Endpoints for client configuration. //! Endpoints for client configuration.
/// PUT /_matrix/client/r0/user/:user_id/rooms/:room_id/account_data/:type /// PUT /_matrix/client/r0/user/:user_id/rooms/:room_id/account_data/:type
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-user-userid-rooms-roomid-account-data-type)
pub mod set_room_account_data { pub mod set_room_account_data {
use ruma_identifiers::{RoomId, UserId}; use ruma_identifiers::{RoomId, UserId};
@ -41,6 +43,8 @@ pub mod set_room_account_data {
} }
/// PUT /_matrix/client/r0/user/:user_id/account_data/:type /// PUT /_matrix/client/r0/user/:user_id/account_data/:type
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-user-userid-account-data-type)
pub mod set_global_account_data { pub mod set_global_account_data {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;

6
src/r0/contact.rs
View File

@ -1,6 +1,8 @@
//! Endpoints for account contact information. //! Endpoints for account contact information.
/// POST /_matrix/client/r0/account/3pid /// POST /_matrix/client/r0/account/3pid
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-account-3pid)
pub mod add_contact { pub mod add_contact {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
@ -41,6 +43,8 @@ pub mod add_contact {
} }
/// GET /_matrix/client/r0/account/3pid /// GET /_matrix/client/r0/account/3pid
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-account-3pid)
pub mod get_contacts { pub mod get_contacts {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;
@ -86,6 +90,8 @@ pub mod get_contacts {
} }
/// POST /_matrix/client/r0/account/3pid/email/requestToken /// POST /_matrix/client/r0/account/3pid/email/requestToken
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-account-3pid-email-requesttoken)
pub mod request_contact_verification_token { pub mod request_contact_verification_token {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]

2
src/r0/context.rs
View File

@ -1,6 +1,8 @@
//! Endpoints for event context. //! Endpoints for event context.
/// GET /_matrix/client/r0/rooms/:room_id/context/:event_id /// GET /_matrix/client/r0/rooms/:room_id/context/:event_id
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-context-eventid)
pub mod get_context { pub mod get_context {
use ruma_identifiers::{EventId, RoomId}; use ruma_identifiers::{EventId, RoomId};
use ruma_events::collections::only; use ruma_events::collections::only;

16
src/r0/membership.rs
View File

@ -16,6 +16,8 @@ pub struct ThirdPartySigned {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/invite /// POST /_matrix/client/r0/rooms/{roomId}/invite
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-invite)
pub mod invite { pub mod invite {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -58,6 +60,8 @@ pub mod invite {
} }
/// POST /_matrix/client/r0/join/{roomIdOrAlias} /// POST /_matrix/client/r0/join/{roomIdOrAlias}
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-join-roomidoralias)
pub mod join_by_room_id_or_alias { pub mod join_by_room_id_or_alias {
use ruma_identifiers::{RoomId, RoomIdOrAliasId}; use ruma_identifiers::{RoomId, RoomIdOrAliasId};
use super::ThirdPartySigned; use super::ThirdPartySigned;
@ -117,6 +121,8 @@ pub mod join_by_room_id_or_alias {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/join /// POST /_matrix/client/r0/rooms/{roomId}/join
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-join)
pub mod join_by_room_id { pub mod join_by_room_id {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
use super::ThirdPartySigned; use super::ThirdPartySigned;
@ -166,6 +172,8 @@ pub mod join_by_room_id {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/forget /// POST /_matrix/client/r0/rooms/{roomId}/forget
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-forget)
pub mod forget { pub mod forget {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -202,6 +210,8 @@ pub mod forget {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/leave /// POST /_matrix/client/r0/rooms/{roomId}/leave
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-leave)
pub mod leave { pub mod leave {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -238,6 +248,8 @@ pub mod leave {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/kick /// POST /_matrix/client/r0/rooms/{roomId}/kick
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-kick)
pub mod kick { pub mod kick {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -281,6 +293,8 @@ pub mod kick {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/unban /// POST /_matrix/client/r0/rooms/{roomId}/unban
///
/// [matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-unban)
pub mod unban { pub mod unban {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -323,6 +337,8 @@ pub mod unban {
} }
/// POST /_matrix/client/r0/rooms/{roomId}/ban /// POST /_matrix/client/r0/rooms/{roomId}/ban
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-rooms-roomid-ban)
pub mod ban { pub mod ban {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;

2
src/r0/room.rs
View File

@ -1,6 +1,8 @@
//! Endpoints for room creation. //! Endpoints for room creation.
/// POST /_matrix/client/r0/createRoom /// POST /_matrix/client/r0/createRoom
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-createroom)
pub mod create_room { pub mod create_room {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;

6
src/r0/session.rs
View File

@ -1,6 +1,8 @@
//! Endpoints for user session management. //! Endpoints for user session management.
/// POST /_matrix/client/r0/login /// POST /_matrix/client/r0/login
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-login)
pub mod login { pub mod login {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;
@ -35,6 +37,8 @@ pub mod login {
} }
/// POST /_matrix/client/r0/logout /// POST /_matrix/client/r0/logout
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-logout)
pub mod logout { pub mod logout {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;
@ -60,6 +64,8 @@ pub mod logout {
} }
/// POST /_matrix/client/r0/tokenrefresh /// POST /_matrix/client/r0/tokenrefresh
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-tokenrefresh)
pub mod refresh_access_token { pub mod refresh_access_token {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]