Skip to content

Commit 4e7676f

Browse files
committed
fix to official documentation, remove loading state
1 parent 302bcb5 commit 4e7676f

File tree

2 files changed

+16
-31
lines changed

2 files changed

+16
-31
lines changed

src/model/application/component.rs

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ impl<'de> Deserialize<'de> for Component {
115115

116116
/// A component that is a container for up to 3 text display components and an accessory.
117117
///
118-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
118+
/// [Discord docs](https://discord.com/developers/docs/components/reference#section)
119119
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
120120
#[derive(Clone, Debug, Deserialize, Serialize)]
121121
#[non_exhaustive]
@@ -139,7 +139,7 @@ pub struct Section {
139139
///
140140
/// See [`Section`] for how this fits within a section.
141141
///
142-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
142+
/// [Discord docs](https://discord.com/developers/docs/components/reference#thumbnail)
143143
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
144144
#[derive(Clone, Debug, Deserialize, Serialize)]
145145
#[non_exhaustive]
@@ -156,9 +156,9 @@ pub struct Thumbnail {
156156
pub spoiler: Option<bool>,
157157
}
158158

159-
/// An unfurled media item.
159+
/// A url or attachment.
160160
///
161-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
161+
/// [Discord docs](https://discord.com/developers/docs/components/reference#unfurled-media-item-structure)
162162
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
163163
#[derive(Clone, Debug, Deserialize, Serialize)]
164164
#[non_exhaustive]
@@ -174,28 +174,12 @@ pub struct UnfurledMediaItem {
174174
pub height: Option<NonMaxU32>,
175175
/// The content type of the media item.
176176
pub content_type: Option<FixedString>,
177-
/// The loading state of the item, declaring if it has fully loaded yet.
178-
pub loading_state: Option<UnfurledMediaItemLoadingState>,
179177
}
180178

181-
#[cfg(feature = "unstable")]
182-
enum_number! {
183-
/// The loading state of the media item.
184-
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Deserialize, Serialize)]
185-
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
186-
#[non_exhaustive]
187-
pub enum UnfurledMediaItemLoadingState {
188-
DiscordUnknown = 0,
189-
Loading = 1,
190-
LoadingSuccess = 2,
191-
LoadingNotFound = 3,
192-
_ => Unknown(u8),
193-
}
194-
}
195-
196-
/// A text display component.
179+
/// A component that allows you to add text to your message, similiar to the `content` field of a
180+
/// message.
197181
///
198-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
182+
/// [Discord docs](https://discord.com/developers/docs/components/reference#text-display)
199183
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
200184
#[derive(Clone, Debug, Deserialize, Serialize)]
201185
#[non_exhaustive]
@@ -205,9 +189,10 @@ pub struct TextDisplay {
205189
pub content: FixedString<u16>,
206190
}
207191

208-
/// A media gallery component.
192+
/// A Media Gallery is a component that allows you to display media attachments in an organized
193+
/// gallery format.
209194
///
210-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
195+
/// [Discord docs](https://discord.com/developers/docs/components/reference#media-gallery)
211196
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
212197
#[derive(Clone, Debug, Deserialize, Serialize)]
213198
#[non_exhaustive]
@@ -224,7 +209,7 @@ pub struct MediaGallery {
224209
///
225210
/// Belongs to [`MediaGallery`].
226211
///
227-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
212+
/// [Discord docs](https://discord.com/developers/docs/components/reference#media-gallery-media-gallery-item-structure)
228213
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
229214
#[derive(Clone, Debug, Deserialize, Serialize)]
230215
#[non_exhaustive]
@@ -238,9 +223,9 @@ pub struct MediaGalleryItem {
238223
pub spoiler: Option<bool>,
239224
}
240225

241-
/// A separator component
226+
/// A component that adds vertical padding and visual division between other components.
242227
///
243-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
228+
/// [Discord docs](https://discord.com/developers/docs/components/reference#separator)
244229
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
245230
#[derive(Clone, Debug, Deserialize, Serialize)]
246231
#[non_exhaustive]
@@ -270,7 +255,7 @@ enum_number! {
270255

271256
/// A file component, will not render a text preview to the user.
272257
///
273-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
258+
/// [Discord docs](https://discord.com/developers/docs/components/reference#file)
274259
#[derive(Clone, Debug, Deserialize, Serialize)]
275260
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
276261
#[non_exhaustive]
@@ -287,7 +272,7 @@ pub struct FileComponent {
287272

288273
/// A container component, similar to an embed but without all the functionality.
289274
///
290-
/// [Discord docs](https://github.com/discord/discord-api-docs/pull/7487/)
275+
/// [Discord docs](https://discord.com/developers/docs/components/reference#container)
291276
#[derive(Clone, Debug, Deserialize, Serialize)]
292277
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
293278
#[non_exhaustive]

src/model/channel/message.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -971,7 +971,7 @@ bitflags! {
971971
/// - Files will not have a simple text preview.
972972
/// - URLs will not generate embeds.
973973
///
974-
/// For more details, refer to the Discord documentation: [https://github.com/discord/discord-api-docs/pull/7487/]
974+
/// For more details, refer to the Discord documentation: [https://discord.com/developers/docs/components/reference#component-reference]
975975
const IS_COMPONENTS_V2 = 1 << 15;
976976

977977
}

0 commit comments

Comments
 (0)