1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! [GET /_matrix/client/r0/register/available](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available)

use ruma_api::ruma_api;

ruma_api! {
    metadata {
        description: "Checks to see if a username is available, and valid, for the server.",
        method: GET,
        name: "get_username_availability",
        path: "/_matrix/client/r0/register/available",
        rate_limited: true,
        requires_authentication: false,
    }

    request {
        /// The username to check the availability of.
        #[ruma_api(query)]
        pub username: String,
    }

    response {
        /// A flag to indicate that the username is available.
        /// This should always be true when the server replies with 200 OK.
        pub available: bool
    }

    error: crate::Error
}