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

Link endpoint paths directly to the spec.

Browse Source
This commit is contained in:
Jimmy Cuadra 2016-12-30 14:26:26 -08:00
parent 8df29f8898
commit b103b87090
19 changed files with 55 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib.rs
View File

@ -42,7 +42,5 @@ pub mod r0 {
pub mod voip; pub mod voip;
} }
/// GET /_matrix/client/versions /// [GET /_matrix/client/versions](https://matrix.org/docs/spec/client_server/r0.2.0.html#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;

20
src/r0/account.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for account registration and management. //! Endpoints for account registration and management.
/// POST /_matrix/client/r0/register /// [POST /_matrix/client/r0/register](https://matrix.org/docs/spec/client_server/r0.2.0.html#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)]
@ -61,9 +59,7 @@ pub mod register {
} }
} }
/// POST /_matrix/client/r0/account/password/email/requestToken /// [POST /_matrix/client/r0/account/password/email/requestToken](https://matrix.org/docs/spec/client_server/r0.2.0.html#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)]
@ -98,9 +94,7 @@ pub mod request_password_change_token {
} }
} }
/// POST /_matrix/client/r0/account/deactivate /// [POST /_matrix/client/r0/account/deactivate](https://matrix.org/docs/spec/client_server/r0.2.0.html#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;
@ -125,9 +119,7 @@ pub mod deactivate {
} }
} }
/// POST /_matrix/client/r0/account/password /// [POST /_matrix/client/r0/account/password](https://matrix.org/docs/spec/client_server/r0.2.0.html#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)]
@ -158,9 +150,7 @@ pub mod change_password {
} }
} }
/// POST /_matrix/client/r0/register/email/requestToken /// [POST /_matrix/client/r0/register/email/requestToken](https://matrix.org/docs/spec/client_server/r0.2.0.html#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)]

12
src/r0/alias.rs
View File

@ -2,9 +2,7 @@
use ruma_identifiers::RoomAliasId; use ruma_identifiers::RoomAliasId;
/// PUT /_matrix/client/r0/directory/room/:room_alias /// [PUT /_matrix/client/r0/directory/room/:room_alias](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-directory-room-roomalias)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-directory-room-roomalias)
pub mod create_alias { pub mod create_alias {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -37,9 +35,7 @@ pub mod create_alias {
} }
} }
/// DELETE /_matrix/client/r0/directory/room/:room_alias /// [DELETE /_matrix/client/r0/directory/room/:room_alias](https://matrix.org/docs/spec/client_server/r0.2.0.html#delete-matrix-client-r0-directory-room-roomalias)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#delete-matrix-client-r0-directory-room-roomalias)
pub mod delete_alias { pub mod delete_alias {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;
@ -64,9 +60,7 @@ pub mod delete_alias {
} }
} }
/// GET /_matrix/client/r0/directory/room/:room_alias /// [GET /_matrix/client/r0/directory/room/:room_alias](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-directory-room-roomalias)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-directory-room-roomalias)
pub mod get_alias { pub mod get_alias {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;

8
src/r0/config.rs
View File

@ -1,8 +1,6 @@
//! 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](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-user-userid-rooms-roomid-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};
@ -42,9 +40,7 @@ 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](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-user-userid-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;

12
src/r0/contact.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for account contact information. //! Endpoints for account contact information.
/// POST /_matrix/client/r0/account/3pid /// [POST /_matrix/client/r0/account/3pid](https://matrix.org/docs/spec/client_server/r0.2.0.html#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 create_contact { pub mod create_contact {
/// This API endpoint's body parameters. /// This API endpoint's body parameters.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
@ -43,9 +41,7 @@ pub mod create_contact {
} }
} }
/// GET /_matrix/client/r0/account/3pid /// [GET /_matrix/client/r0/account/3pid](https://matrix.org/docs/spec/client_server/r0.2.0.html#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;
@ -90,9 +86,7 @@ pub mod get_contacts {
} }
} }
/// POST /_matrix/client/r0/account/3pid/email/requestToken /// [POST /_matrix/client/r0/account/3pid/email/requestToken](https://matrix.org/docs/spec/client_server/r0.2.0.html#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)]

4
src/r0/context.rs
View File

@ -1,8 +1,6 @@
//! 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](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-context-eventid)
///
/// [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;

4
src/r0/directory.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for the public room directory. //! Endpoints for the public room directory.
/// GET /_matrix/client/r0/publicRooms /// [GET /_matrix/client/r0/publicRooms](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-publicrooms)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-publicrooms)
pub mod get_public_rooms { pub mod get_public_rooms {
use ruma_identifiers::{RoomId, RoomAliasId}; use ruma_identifiers::{RoomId, RoomAliasId};

8
src/r0/filter.rs
View File

@ -94,9 +94,7 @@ pub struct FilterDefinition {
pub presence: Option<Filter> pub presence: Option<Filter>
} }
/// POST /_matrix/client/r0/user/{userId}/filter /// [POST /_matrix/client/r0/user/{userId}/filter](https://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-user-userid-filter)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-user-userid-filter)
pub mod create_filter { pub mod create_filter {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
use super::FilterDefinition; use super::FilterDefinition;
@ -139,9 +137,7 @@ pub mod create_filter {
} }
} }
/// GET /_matrix/client/r0/user/{userId}/filter/{filterId} /// [GET /_matrix/client/r0/user/{userId}/filter/{filterId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-user-userid-filter-filterid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-user-userid-filter-filterid)
pub mod get_filter { pub mod get_filter {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
use super::FilterDefinition; use super::FilterDefinition;

32
src/r0/membership.rs
View File

@ -15,9 +15,7 @@ pub struct ThirdPartySigned {
pub token: String, pub token: String,
} }
/// POST /_matrix/client/r0/rooms/{roomId}/invite /// [POST /_matrix/client/r0/rooms/{roomId}/invite](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_user { pub mod invite_user {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -59,9 +57,7 @@ pub mod invite_user {
} }
} }
/// POST /_matrix/client/r0/join/{roomIdOrAlias} /// [POST /_matrix/client/r0/join/{roomIdOrAlias}](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_room_by_id_or_alias { pub mod join_room_by_id_or_alias {
use ruma_identifiers::{RoomId, RoomIdOrAliasId}; use ruma_identifiers::{RoomId, RoomIdOrAliasId};
use super::ThirdPartySigned; use super::ThirdPartySigned;
@ -121,9 +117,7 @@ pub mod join_room_by_id_or_alias {
} }
} }
/// POST /_matrix/client/r0/rooms/{roomId}/join /// [POST /_matrix/client/r0/rooms/{roomId}/join](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_room_by_id { pub mod join_room_by_id {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
use super::ThirdPartySigned; use super::ThirdPartySigned;
@ -173,9 +167,7 @@ pub mod join_room_by_id {
} }
} }
/// POST /_matrix/client/r0/rooms/{roomId}/forget /// [POST /_matrix/client/r0/rooms/{roomId}/forget](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_room { pub mod forget_room {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -211,9 +203,7 @@ pub mod forget_room {
} }
} }
/// POST /_matrix/client/r0/rooms/{roomId}/leave /// [POST /_matrix/client/r0/rooms/{roomId}/leave](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_room { pub mod leave_room {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -249,9 +239,7 @@ pub mod leave_room {
} }
} }
/// POST /_matrix/client/r0/rooms/{roomId}/kick /// [POST /_matrix/client/r0/rooms/{roomId}/kick](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_user { pub mod kick_user {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -295,9 +283,7 @@ pub mod kick_user {
} }
} }
/// POST /_matrix/client/r0/rooms/{roomId}/unban /// [POST /_matrix/client/r0/rooms/{roomId}/unban](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_user { pub mod unban_user {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -339,9 +325,7 @@ pub mod unban_user {
} }
} }
/// POST /_matrix/client/r0/rooms/{roomId}/ban /// [POST /_matrix/client/r0/rooms/{roomId}/ban](https://matrix.org/docs/spec/client_server/r0.2.0.html#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_user { pub mod ban_user {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;

16
src/r0/presence.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for user presence. //! Endpoints for user presence.
/// PUT /_matrix/client/r0/presence/{userId}/status /// [PUT /_matrix/client/r0/presence/{userId}/status](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-presence-userid-status)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-presence-userid-status)
pub mod set_presence { pub mod set_presence {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
use ruma_events::presence::PresenceState; use ruma_events::presence::PresenceState;
@ -47,9 +45,7 @@ pub mod set_presence {
} }
} }
/// GET /_matrix/client/r0/presence/{userId}/status /// [GET /_matrix/client/r0/presence/{userId}/status](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-presence-userid-status)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-presence-userid-status)
pub mod get_presence { pub mod get_presence {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
use ruma_events::presence::PresenceState; use ruma_events::presence::PresenceState;
@ -98,9 +94,7 @@ pub mod get_presence {
} }
} }
/// POST /_matrix/client/r0/presence/list/{userId} /// [POST /_matrix/client/r0/presence/list/{userId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-presence-list-userid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-presence-list-userid)
pub mod update_presence_subscriptions { pub mod update_presence_subscriptions {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
@ -147,9 +141,7 @@ pub mod update_presence_subscriptions {
} }
} }
/// GET /_matrix/client/r0/presence/list/{userId} /// [GET /_matrix/client/r0/presence/list/{userId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-presence-list-userid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-presence-list-userid)
pub mod get_subscribed_presences { pub mod get_subscribed_presences {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
use ruma_events::presence::PresenceEvent; use ruma_events::presence::PresenceEvent;

20
src/r0/profile.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for user profiles. //! Endpoints for user profiles.
/// GET /_matrix/client/r0/profile/{userId}/displayname /// [GET /_matrix/client/r0/profile/{userId}/displayname](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid-displayname)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid-displayname)
pub mod get_display_name { pub mod get_display_name {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
@ -46,9 +44,7 @@ pub mod get_display_name {
} }
/// PUT /_matrix/client/r0/profile/{userId}/displayname /// [PUT /_matrix/client/r0/profile/{userId}/displayname](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-profile-userid-displayname)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-profile-userid-displayname)
pub mod set_display_name { pub mod set_display_name {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
@ -91,9 +87,7 @@ pub mod set_display_name {
} }
} }
/// GET /_matrix/client/r0/profile/{userId}/avatar_url /// [GET /_matrix/client/r0/profile/{userId}/avatar_url](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid-avatar-url)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid-avatar-url)
pub mod get_avatar_url { pub mod get_avatar_url {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
@ -136,9 +130,7 @@ pub mod get_avatar_url {
} }
} }
/// PUT /_matrix/client/r0/profile/{userId}/avatar_url /// [PUT /_matrix/client/r0/profile/{userId}/avatar_url](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-profile-userid-avatar-url)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-profile-userid-avatar-url)
pub mod set_avatar_url { pub mod set_avatar_url {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;
@ -181,9 +173,7 @@ pub mod set_avatar_url {
} }
} }
/// GET /_matrix/client/r0/profile/{userId} /// [GET /_matrix/client/r0/profile/{userId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid)
pub mod get_profile { pub mod get_profile {
use ruma_identifiers::UserId; use ruma_identifiers::UserId;

4
src/r0/redact.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for event redaction. //! Endpoints for event redaction.
/// PUT /_matrix/client/r0/rooms/{roomId}/redact/{eventId}/{txnId} /// [PUT /_matrix/client/r0/rooms/{roomId}/redact/{eventId}/{txnId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-redact-eventid-txnid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-redact-eventid-txnid)
pub mod redact_event { pub mod redact_event {
use ruma_identifiers::{RoomId, EventId}; use ruma_identifiers::{RoomId, EventId};

4
src/r0/room.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for room creation. //! Endpoints for room creation.
/// POST /_matrix/client/r0/createRoom /// [POST /_matrix/client/r0/createRoom](https://matrix.org/docs/spec/client_server/r0.2.0.html#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;

12
src/r0/send.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for sending events. //! Endpoints for sending events.
/// PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType} /// [PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype)
pub mod send_state_event { pub mod send_state_event {
use ruma_identifiers::{RoomId, EventId}; use ruma_identifiers::{RoomId, EventId};
use ruma_events::EventType; use ruma_events::EventType;
@ -48,9 +46,7 @@ pub mod send_state_event {
} }
} }
/// PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey} /// [PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype-statekey)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype-statekey)
pub mod send_state_event_by_state_key { pub mod send_state_event_by_state_key {
use ruma_identifiers::{RoomId, EventId}; use ruma_identifiers::{RoomId, EventId};
use ruma_events::EventType; use ruma_events::EventType;
@ -98,9 +94,7 @@ pub mod send_state_event_by_state_key {
} }
} }
/// PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId} /// [PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-send-eventtype-txnid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-send-eventtype-txnid)
pub mod send_message_event { pub mod send_message_event {
use ruma_identifiers::{RoomId, EventId}; use ruma_identifiers::{RoomId, EventId};
use ruma_events::EventType; use ruma_events::EventType;

12
src/r0/session.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for user session management. //! Endpoints for user session management.
/// POST /_matrix/client/r0/login /// [POST /_matrix/client/r0/login](https://matrix.org/docs/spec/client_server/r0.2.0.html#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;
@ -37,9 +35,7 @@ pub mod login {
} }
} }
/// POST /_matrix/client/r0/logout /// [POST /_matrix/client/r0/logout](https://matrix.org/docs/spec/client_server/r0.2.0.html#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;
@ -64,9 +60,7 @@ pub mod logout {
} }
} }
/// POST /_matrix/client/r0/tokenrefresh /// [POST /_matrix/client/r0/tokenrefresh](https://matrix.org/docs/spec/client_server/r0.2.0.html#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)]

25
src/r0/sync.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for getting and synchronizing events. //! Endpoints for getting and synchronizing events.
/// GET /_matrix/client/r0/rooms/{roomId}/state /// [GET /_matrix/client/r0/rooms/{roomId}/state](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-state)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-state)
pub mod get_state_events { pub mod get_state_events {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
use ruma_events::collections::only; use ruma_events::collections::only;
@ -39,9 +37,7 @@ pub mod get_state_events {
} }
} }
/// GET /_matrix/client/r0/rooms/{roomId}/state/{eventType} /// [GET /_matrix/client/r0/rooms/{roomId}/state/{eventType}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-state-eventtype)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-state-eventtype)
pub mod get_state_event_by_event_type { pub mod get_state_event_by_event_type {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -79,9 +75,7 @@ pub mod get_state_event_by_event_type {
} }
} }
/// GET /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey} /// [GET /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-state-eventtype-state-key)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-state-eventtype-state-key)
pub mod get_state_event_by_state_key { pub mod get_state_event_by_state_key {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
@ -121,9 +115,7 @@ pub mod get_state_event_by_state_key {
} }
} }
/// GET /_matrix/client/r0/rooms/{roomId}/members /// [GET /_matrix/client/r0/rooms/{roomId}/members](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-members)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-members)
pub mod get_member_events { pub mod get_member_events {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
use ruma_events::room::member::MemberEvent; use ruma_events::room::member::MemberEvent;
@ -166,9 +158,7 @@ pub mod get_member_events {
} }
} }
/// GET /_matrix/client/r0/rooms/{roomId}/messages /// [GET /_matrix/client/r0/rooms/{roomId}/messages](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-messages)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-messages)
pub mod get_message_events { pub mod get_message_events {
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;
use ruma_events::collections::only; use ruma_events::collections::only;
@ -232,9 +222,8 @@ pub mod get_message_events {
} }
} }
} }
/// GET /_matrix/client/r0/sync
/// /// [GET /_matrix/client/r0/sync](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-sync)
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-sync)
pub mod sync_events { pub mod sync_events {
use ruma_events::collections::only; use ruma_events::collections::only;
use ruma_identifiers::RoomId; use ruma_identifiers::RoomId;

12
src/r0/tag.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for tagging rooms. //! Endpoints for tagging rooms.
/// PUT /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag} /// [PUT /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag}](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-user-userid-rooms-roomid-tags-tag)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-user-userid-rooms-roomid-tags-tag)
pub mod create_tag { pub mod create_tag {
use ruma_identifiers::{UserId, RoomId}; use ruma_identifiers::{UserId, RoomId};
use ruma_events::tag::TagInfo; use ruma_events::tag::TagInfo;
@ -43,9 +41,7 @@ pub mod create_tag {
} }
} }
/// GET /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags /// [GET /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-user-userid-rooms-roomid-tags)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-user-userid-rooms-roomid-tags)
pub mod get_tags { pub mod get_tags {
use ruma_identifiers::{UserId, RoomId}; use ruma_identifiers::{UserId, RoomId};
use ruma_events::tag::TagEventContent; use ruma_events::tag::TagEventContent;
@ -90,9 +86,7 @@ pub mod get_tags {
} }
} }
/// DELETE /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag} /// [DELETE /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag}](https://matrix.org/docs/spec/client_server/r0.2.0.html#delete-matrix-client-r0-user-userid-rooms-roomid-tags-tag)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#delete-matrix-client-r0-user-userid-rooms-roomid-tags-tag)
pub mod delete_tag { pub mod delete_tag {
use ruma_identifiers::{UserId, RoomId}; use ruma_identifiers::{UserId, RoomId};

4
src/r0/typing.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for typing notifications. //! Endpoints for typing notifications.
/// PUT /_matrix/client/r0/rooms/{roomId}/typing/{userId} /// [PUT /_matrix/client/r0/rooms/{roomId}/typing/{userId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-typing-userid)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-rooms-roomid-typing-userid)
pub mod start_or_stop_typing { pub mod start_or_stop_typing {
use ruma_identifiers::{UserId, RoomId}; use ruma_identifiers::{UserId, RoomId};

4
src/r0/voip.rs
View File

@ -1,8 +1,6 @@
//! Endpoints for Voice over IP. //! Endpoints for Voice over IP.
/// GET /_matrix/client/r0/voip/turnServer /// [GET /_matrix/client/r0/voip/turnServer](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-voip-turnserver)
///
/// [Matrix spec link](http://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-voip-turnserver)
pub mod get_turn_server_info { pub mod get_turn_server_info {
/// Details about this API endpoint. /// Details about this API endpoint.
pub struct Endpoint; pub struct Endpoint;