137 lines
3.7 KiB
Rust
137 lines
3.7 KiB
Rust
pub mod some_endpoint {
|
|
use ruma_api::ruma_api;
|
|
use ruma_common::Raw;
|
|
use ruma_events::{tag::TagEvent, AnyRoomEvent};
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Does something.",
|
|
method: POST, // An `http::Method` constant. No imports required.
|
|
name: "some_endpoint",
|
|
path: "/_matrix/some/endpoint/:baz",
|
|
rate_limited: false,
|
|
requires_authentication: false,
|
|
}
|
|
|
|
request: {
|
|
// With no attribute on the field, it will be put into the body of the request.
|
|
pub foo: String,
|
|
|
|
// This value will be put into the "Content-Type" HTTP header.
|
|
#[ruma_api(header = CONTENT_TYPE)]
|
|
pub content_type: String,
|
|
|
|
// This value will be put into the query string of the request's URL.
|
|
#[ruma_api(query)]
|
|
pub bar: String,
|
|
|
|
// This value will be inserted into the request's URL in place of the
|
|
// ":baz" path component.
|
|
#[ruma_api(path)]
|
|
pub baz: String,
|
|
}
|
|
|
|
response: {
|
|
// This value will be extracted from the "Content-Type" HTTP header.
|
|
#[ruma_api(header = CONTENT_TYPE)]
|
|
pub content_type: String,
|
|
|
|
// With no attribute on the field, it will be extracted from the body of the response.
|
|
pub value: String,
|
|
|
|
// You can use serde attributes on any kind of field
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub optional_flag: Option<bool>,
|
|
|
|
// Use `Raw` instead of the actual event to allow additional fields to be sent...
|
|
pub event: Raw<TagEvent>,
|
|
|
|
// ... and to allow unknown events when the endpoint deals with event collections.
|
|
pub list_of_events: Vec<Raw<AnyRoomEvent>>,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub mod newtype_body_endpoint {
|
|
use ruma_api::ruma_api;
|
|
|
|
#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
|
|
pub struct MyCustomType {
|
|
pub foo: String,
|
|
}
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Does something.",
|
|
method: PUT,
|
|
name: "newtype_body_endpoint",
|
|
path: "/_matrix/some/newtype/body/endpoint",
|
|
rate_limited: false,
|
|
requires_authentication: false,
|
|
}
|
|
|
|
request: {
|
|
#[ruma_api(body)]
|
|
pub list_of_custom_things: Vec<MyCustomType>,
|
|
}
|
|
|
|
response: {
|
|
#[ruma_api(body)]
|
|
pub my_custom_thing: MyCustomType,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub mod newtype_raw_body_endpoint {
|
|
use ruma_api::ruma_api;
|
|
|
|
#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
|
|
pub struct MyCustomType {
|
|
pub foo: String,
|
|
}
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Does something.",
|
|
method: PUT,
|
|
name: "newtype_body_endpoint",
|
|
path: "/_matrix/some/newtype/body/endpoint",
|
|
rate_limited: false,
|
|
requires_authentication: false,
|
|
}
|
|
|
|
request: {
|
|
#[ruma_api(raw_body)]
|
|
pub file: Vec<u8>,
|
|
}
|
|
|
|
response: {
|
|
#[ruma_api(raw_body)]
|
|
pub file: Vec<u8>,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub mod query_map_endpoint {
|
|
use ruma_api::ruma_api;
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Does something.",
|
|
method: GET,
|
|
name: "newtype_body_endpoint",
|
|
path: "/_matrix/some/query/map/endpoint",
|
|
rate_limited: false,
|
|
requires_authentication: false,
|
|
}
|
|
|
|
request: {
|
|
#[ruma_api(query_map)]
|
|
pub fields: Vec<(String, String)>,
|
|
}
|
|
|
|
response: {
|
|
}
|
|
}
|
|
}
|