OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2024-12-22 14:35:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix docs for uploadStickerFile method

Browse source
This commit is contained in:
Сырцев Вадим Игоревич 2024-06-06 18:00:18 +03:00
parent 0bbc789caa
commit c24fdf173e
2 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
crates/teloxide-core/schema.ron
View file

@ -3575,7 +3575,14 @@ Schema(
Method(
names: ("uploadStickerFile", "UploadStickerFile", "upload_sticker_file"),
return_ty: RawTy("FileMeta"),
doc: Doc(md: "Use this method to upload a .PNG file with a sticker for later use in _createNewStickerSet_ and _addStickerToSet_ methods (can be used multiple times). Returns the uploaded File on success."),
doc: Doc(
md: "Use this method to upload a file with a sticker for later use in the [CreateNewStickerSet] and [AddStickerToSet] methods (the file can be used multiple times). Returns the uploaded [File] on success.",
md_links: {
"CreateNewStickerSet": "https://docs.rs/teloxide/latest/teloxide/payloads/struct.CreateNewStickerSet.html",
"AddStickerToSet": "https://docs.rs/teloxide/latest/teloxide/payloads/struct.AddStickerToSet.html",
"File": "https://core.telegram.org/bots/api#file"
}
),
tg_doc: "https://core.telegram.org/bots/api#uploadstickerfile",
tg_category: "Stickers",
params: [
@ -3588,8 +3595,11 @@ Schema(
name: "sticker",
ty: RawTy("InputFile"),
descr: Doc(
md: "A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
md: "A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. [Technical requirements]. [More info on Sending Files »]",
md_links: {
"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files",
"Technical requirements": "https://core.telegram.org/stickers"
},
),
),
Param(

9
crates/teloxide-core/src/payloads/upload_sticker_file.rs
View file

@ -6,15 +6,20 @@ use crate::types::{FileMeta, InputFile, StickerFormat, UserId};
impl_payload! {
@[multipart = sticker]
/// Use this method to upload a .PNG file with a sticker for later use in _createNewStickerSet_ and _addStickerToSet_ methods (can be used multiple times). Returns the uploaded File on success.
/// Use this method to upload a file with a sticker for later use in the [CreateNewStickerSet] and [AddStickerToSet] methods (the file can be used multiple times). Returns the uploaded [`File`] on success.
///
/// [CreateNewStickerSet]: https://docs.rs/teloxide/latest/teloxide/payloads/struct.CreateNewStickerSet.html
/// [AddStickerToSet]: https://docs.rs/teloxide/latest/teloxide/payloads/struct.AddStickerToSet.html
/// [`File`]: crate::types::File
#[derive(Debug, Clone, Serialize)]
pub UploadStickerFile (UploadStickerFileSetters) => FileMeta {
required {
/// User identifier of sticker file owner
pub user_id: UserId,
/// A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. [More info on Sending Files »]
/// A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. [Technical requirements]. [More info on Sending Files »]
///
/// [More info on Sending Files »]: crate::types::InputFile
/// [Technical requirements]: https://core.telegram.org/stickers
pub sticker: InputFile,
/// Format of the sticker, must be one of “static”, “animated”, “video”
pub sticker_format: StickerFormat,