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

Update ruma_api! docs

Browse Source
This commit is contained in:
Jonas Platte 2019-11-20 23:36:11 +01:00
parent d054bbb407
commit 65568dbf1b
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ruma-api-macros/src/lib.rs
View File

@ -28,7 +28,7 @@ mod api;
/// ///
/// The macro expects the following structure as input: /// The macro expects the following structure as input:
/// ///
/// ```text /// ```rust
/// ruma_api! { /// ruma_api! {
/// metadata { /// metadata {
/// description: &'static str /// description: &'static str
@ -49,7 +49,6 @@ mod api;
/// // in the response from this API endpoint. /// // in the response from this API endpoint.
/// } /// }
/// } /// }
/// # }
/// ``` /// ```
/// ///
/// This will generate a `ruma_api::Metadata` value to be used for the `ruma_api::Endpoint`'s /// This will generate a `ruma_api::Metadata` value to be used for the `ruma_api::Endpoint`'s
@ -92,6 +91,10 @@ mod api;
/// component of the request URL. /// component of the request URL.
/// * `#[ruma_api(query)]`: Fields with this attribute will be inserting into the URL's query /// * `#[ruma_api(query)]`: Fields with this attribute will be inserting into the URL's query
/// string. /// string.
/// * `#[ruma_api(query_map)]`: Instead of individual query fields, one query_map field, of any
/// type that implements `IntoIterator<Item = (String, String)>` (e.g.
/// `HashMap<String, String>`, can be used for cases where an endpoint supports arbitrary query
/// parameters.
/// ///
/// Any field that does not include one of these attributes will be part of the request's JSON /// Any field that does not include one of these attributes will be part of the request's JSON
/// body. /// body.