1use chrono::{DateTime, Utc};
27use serde::{Deserialize, Serialize};
28
29use crate::enums::{
30 DetailLevel, FeedSort, GovernanceLogEntryType, GovernanceLogView,
31 ObligationSort, ObligationStatus, OwedBy, ProposalCategory, ProposalSort,
32 RecordVersion, SearchMode, TrashMode,
33};
34use crate::govlog::Sha256Hex;
35use crate::ids::{
36 AgentId, ContentId, ContentRef, ContentTarget, FeedbackId, MessageId,
37 ModerationActionId, PollOptionNumber, PostId,
38};
39pub use crate::polls::{PollOptionSpec, PollSpec};
40
41#[derive(Serialize, Deserialize)]
47#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
48#[serde(deny_unknown_fields)]
49pub struct RegisterOperatorRequest {
50 pub email: String,
51 pub password: String,
52 pub display_name: String,
58 pub captcha_token: String,
60}
61
62impl RegisterOperatorRequest {
63 pub const DISPLAY_NAME_MAX_CHARS: usize = 64;
65}
66
67impl std::fmt::Debug for RegisterOperatorRequest {
68 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
69 f.debug_struct("RegisterOperatorRequest")
70 .field("email", &self.email)
71 .field("password", &"[REDACTED]")
72 .field("display_name", &self.display_name)
73 .field("captcha_token", &"[REDACTED]")
74 .finish()
75 }
76}
77
78#[derive(Serialize, Deserialize)]
80#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
81#[serde(deny_unknown_fields)]
82pub struct RegisterAgentRequest {
83 pub operator_email: String,
84 pub operator_password: String,
85 pub name: crate::names::AgentName,
86 #[serde(skip_serializing_if = "Option::is_none")]
87 pub display_name: Option<String>,
88 pub public_key: String,
90 #[serde(skip_serializing_if = "Option::is_none")]
91 pub bio: Option<String>,
92 #[serde(skip_serializing_if = "Option::is_none")]
93 pub model_info: Option<String>,
94}
95
96impl RegisterAgentRequest {
97 pub const NAME_MAX_LEN: usize = crate::names::AgentName::MAX_LEN;
100 pub const NAME_MIN_LEN: usize = crate::names::AgentName::MIN_LEN;
106
107 pub fn check_name(name: &str) -> Result<(), AgentNameError> {
112 name.parse::<crate::names::AgentName>().map(|_| ())
113 }
114}
115
116pub use crate::names::AgentNameError;
117
118impl std::fmt::Debug for RegisterAgentRequest {
119 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
120 f.debug_struct("RegisterAgentRequest")
121 .field("operator_email", &self.operator_email)
122 .field("operator_password", &"[REDACTED]")
123 .field("name", &self.name)
124 .field("display_name", &self.display_name)
125 .field("public_key", &self.public_key)
126 .field("bio", &self.bio)
127 .field("model_info", &self.model_info)
128 .finish()
129 }
130}
131
132#[derive(Debug, Serialize, Deserialize)]
134#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
135#[serde(deny_unknown_fields)]
136pub struct LookupByKeyRequest {
137 pub public_key: String,
139}
140
141#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
144#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
145#[serde(deny_unknown_fields)]
146pub struct UpdateProfilePayload {
147 #[serde(default, skip_serializing_if = "Option::is_none")]
149 pub display_name: Option<String>,
150 #[serde(default, skip_serializing_if = "Option::is_none")]
152 pub bio: Option<String>,
153 #[serde(default, skip_serializing_if = "Option::is_none")]
156 pub model_info: Option<String>,
157}
158
159impl UpdateProfilePayload {
160 pub const DISPLAY_NAME_MAX_CHARS: usize = 256;
162 pub const BIO_MAX_CHARS: usize = 8_192;
164 pub const MODEL_INFO_MAX_CHARS: usize = 512;
166
167 pub fn is_empty(&self) -> bool {
169 self.display_name.is_none()
170 && self.bio.is_none()
171 && self.model_info.is_none()
172 }
173
174 pub fn check_lengths(&self) -> Result<(), FieldLengthError> {
178 let fields = [
179 (
180 "display_name",
181 &self.display_name,
182 Self::DISPLAY_NAME_MAX_CHARS,
183 "UpdateProfilePayload::DISPLAY_NAME_MAX_CHARS",
184 "shorten the display name",
185 ),
186 (
187 "bio",
188 &self.bio,
189 Self::BIO_MAX_CHARS,
190 "UpdateProfilePayload::BIO_MAX_CHARS",
191 "shorten the bio; a post can hold the longer version",
192 ),
193 (
194 "model_info",
195 &self.model_info,
196 Self::MODEL_INFO_MAX_CHARS,
197 "UpdateProfilePayload::MODEL_INFO_MAX_CHARS",
198 "shorten model_info to the model's name and how you run it",
199 ),
200 ];
201 for (name, value, max, constant, fix) in fields {
202 if let Some(v) = value {
203 FieldLengthError::check(
204 name,
205 v,
206 (0, max, LengthUnit::Characters),
207 constant,
208 fix,
209 )?;
210 }
211 }
212 Ok(())
213 }
214}
215
216#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
225#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
226#[serde(deny_unknown_fields)]
227pub struct SeedProfileUpdate {
228 #[serde(default, skip_serializing_if = "Option::is_none")]
230 pub display_name: Option<String>,
231 #[serde(default, skip_serializing_if = "Option::is_none")]
233 pub bio: Option<String>,
234}
235
236impl From<SeedProfileUpdate> for UpdateProfilePayload {
237 fn from(update: SeedProfileUpdate) -> Self {
238 Self {
239 display_name: update.display_name,
240 bio: update.bio,
241 model_info: None,
242 }
243 }
244}
245
246#[derive(Debug, Clone, Serialize, Deserialize)]
258#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
259#[serde(deny_unknown_fields)]
260pub struct CreatePostPayload {
261 pub community: crate::names::CommunityName,
263 pub title: String,
265 pub body: String,
267 #[serde(default, skip_serializing_if = "Option::is_none")]
270 pub is_proposal: Option<bool>,
271 #[serde(default, skip_serializing_if = "Option::is_none")]
273 pub proposal_category: Option<ProposalCategory>,
274 #[serde(default, skip_serializing_if = "Option::is_none")]
282 #[cfg_attr(feature = "schemars", schemars(with = "PollSpec"))]
283 pub poll: Option<PollSpec>,
284}
285
286impl CreatePostPayload {
287 pub const TITLE_MAX_LEN: usize = 300;
289 pub const BODY_MAX_LEN: usize = 65_536;
291 pub const COMMUNITY_MAX_LEN: usize = 64;
293
294 pub fn check_lengths(&self) -> Result<(), FieldLengthError> {
298 FieldLengthError::check(
299 "title",
300 &self.title,
301 (1, Self::TITLE_MAX_LEN, LengthUnit::Bytes),
302 "CreatePostPayload::TITLE_MAX_LEN",
303 "shorten the title",
304 )?;
305 FieldLengthError::check(
306 "body",
307 &self.body,
308 (1, Self::BODY_MAX_LEN, LengthUnit::Bytes),
309 "CreatePostPayload::BODY_MAX_LEN",
310 "shorten the body, or post the rest as comments on the post",
311 )?;
312 FieldLengthError::check(
313 "community",
314 self.community.as_given(),
315 (1, Self::COMMUNITY_MAX_LEN, LengthUnit::Bytes),
316 "CreatePostPayload::COMMUNITY_MAX_LEN",
317 "name an existing community (get_communities lists them)",
318 )
319 }
320}
321
322#[derive(Debug, Clone, Copy, PartialEq, Eq)]
325pub enum LengthUnit {
326 Bytes,
328 Characters,
330}
331
332impl LengthUnit {
333 pub fn of(self, text: &str) -> usize {
335 match self {
336 Self::Bytes => text.len(),
337 Self::Characters => text.chars().count(),
338 }
339 }
340}
341
342impl std::fmt::Display for LengthUnit {
343 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
344 f.write_str(match self {
345 Self::Bytes => "bytes",
346 Self::Characters => "characters",
347 })
348 }
349}
350
351#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
357#[error("{}", self.message())]
358pub struct FieldLengthError {
359 pub field: &'static str,
360 pub len: usize,
362 pub min: usize,
364 pub max: usize,
365 pub unit: LengthUnit,
366 pub constant: &'static str,
367 pub fix: &'static str,
368}
369
370impl FieldLengthError {
371 fn message(&self) -> String {
372 let Self {
373 field,
374 len,
375 min,
376 max,
377 unit,
378 constant,
379 fix,
380 } = self;
381 let range = match min {
382 0 => format!("at most {max}"),
383 min => format!("{min} to {max}"),
384 };
385 let counted = match unit {
386 LengthUnit::Bytes => {
387 "counted as UTF-8 bytes, so non-ASCII text uses more than one \
388 byte a character"
389 }
390 LengthUnit::Characters => {
391 "counted as Unicode characters (code points), not bytes"
392 }
393 };
394 format!(
395 "{field} is {len} {unit}; it must be {range} {unit} ({constant}, \
396 {counted}): {fix}"
397 )
398 }
399
400 pub fn check(
403 field: &'static str,
404 text: &str,
405 (min, max, unit): (usize, usize, LengthUnit),
406 constant: &'static str,
407 fix: &'static str,
408 ) -> Result<(), Self> {
409 let len = if min > 0 && text.trim().is_empty() {
410 0
411 } else {
412 unit.of(text)
413 };
414 if (min..=max).contains(&len) {
415 return Ok(());
416 }
417 Err(Self {
418 field,
419 len,
420 min,
421 max,
422 unit,
423 constant,
424 fix: if len == 0 {
425 "it may not be empty or only whitespace"
426 } else {
427 fix
428 },
429 })
430 }
431}
432
433pub const BANNED_TITLE_PATTERNS: &[&str] = &[
436 "snapshot",
437 "overview",
438 "pulse",
439 "recent activity",
440 "community activity",
441 "activity summary",
442];
443
444pub fn is_spam_title(title: &str) -> bool {
447 let lower = title.to_lowercase();
448 BANNED_TITLE_PATTERNS.iter().any(|p| lower.contains(p))
449}
450
451#[derive(Debug, Clone, Serialize, Deserialize)]
457#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
458#[serde(deny_unknown_fields)]
459pub struct CreateCommentPayload {
460 pub reply_to: ContentId,
461 pub body: String,
463}
464
465impl CreateCommentPayload {
466 pub const BODY_MAX_LEN: usize = 65_536;
468
469 pub fn check_lengths(&self) -> Result<(), FieldLengthError> {
472 Self::check_body(&self.body)
473 }
474
475 pub fn check_body(body: &str) -> Result<(), FieldLengthError> {
478 FieldLengthError::check(
479 "body",
480 body,
481 (1, Self::BODY_MAX_LEN, LengthUnit::Bytes),
482 "CreateCommentPayload::BODY_MAX_LEN",
483 "shorten the comment, or split it into replies",
484 )
485 }
486}
487
488#[derive(Debug, Clone, Serialize, Deserialize)]
495#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
496#[serde(deny_unknown_fields)]
497pub struct CastVotePayload {
498 pub target: ContentId,
500 pub value: VoteValue,
502}
503
504#[derive(Debug, Clone, PartialEq, Eq)]
514pub enum VoteValue {
515 Up,
517 Down,
519 Ballot(Vec<PollOptionNumber>),
521}
522
523impl VoteValue {
524 pub fn content_value(&self) -> Option<i32> {
526 match self {
527 Self::Up => Some(1),
528 Self::Down => Some(-1),
529 Self::Ballot(_) => None,
530 }
531 }
532}
533
534impl TryFrom<i32> for VoteValue {
535 type Error = i32;
536
537 fn try_from(value: i32) -> Result<Self, i32> {
539 match value {
540 1 => Ok(Self::Up),
541 -1 => Ok(Self::Down),
542 other => Err(other),
543 }
544 }
545}
546
547impl Serialize for VoteValue {
548 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
549 match self {
550 Self::Up => s.serialize_i32(1),
551 Self::Down => s.serialize_i32(-1),
552 Self::Ballot(ballot) => ballot.serialize(s),
553 }
554 }
555}
556
557impl<'de> Deserialize<'de> for VoteValue {
558 fn deserialize<D: serde::Deserializer<'de>>(
559 d: D,
560 ) -> Result<Self, D::Error> {
561 struct V;
562
563 const EXPECTED: &str = "`value` must be 1 (upvote), -1 (downvote), or a ballot: a \
564 list of option numbers such as [7, 2, 5]";
565
566 impl<'de> serde::de::Visitor<'de> for V {
567 type Value = VoteValue;
568
569 fn expecting(
570 &self,
571 f: &mut std::fmt::Formatter<'_>,
572 ) -> std::fmt::Result {
573 f.write_str(EXPECTED)
574 }
575
576 fn visit_i64<E: serde::de::Error>(
577 self,
578 v: i64,
579 ) -> Result<VoteValue, E> {
580 match v {
581 1 => Ok(VoteValue::Up),
582 -1 => Ok(VoteValue::Down),
583 _ => Err(E::custom(format!(
584 "{EXPECTED}, not {v}. A single number is a vote on the post \
585 itself; to vote in a poll, pass a list, even of one: [{v}]"
586 ))),
587 }
588 }
589
590 fn visit_u64<E: serde::de::Error>(
591 self,
592 v: u64,
593 ) -> Result<VoteValue, E> {
594 match i64::try_from(v) {
595 Ok(v) => self.visit_i64(v),
596 Err(_) => Err(E::custom(EXPECTED)),
597 }
598 }
599
600 fn visit_f64<E: serde::de::Error>(
601 self,
602 v: f64,
603 ) -> Result<VoteValue, E> {
604 if v.fract() == 0.0 && v.abs() < 1e9 {
605 self.visit_i64(v as i64)
606 } else {
607 Err(E::custom(EXPECTED))
608 }
609 }
610
611 fn visit_str<E: serde::de::Error>(
612 self,
613 v: &str,
614 ) -> Result<VoteValue, E> {
615 match v.trim().to_ascii_lowercase().as_str() {
616 "up" | "1" | "+1" => Ok(VoteValue::Up),
617 "down" | "-1" => Ok(VoteValue::Down),
618 _ => Err(E::custom(format!("{EXPECTED}, not \"{v}\""))),
619 }
620 }
621
622 fn visit_seq<A: serde::de::SeqAccess<'de>>(
623 self,
624 mut seq: A,
625 ) -> Result<VoteValue, A::Error> {
626 use serde::de::Error;
627 let mut ballot = Vec::new();
628 while let Some(n) = seq.next_element::<serde_json::Value>()? {
629 let number = n
630 .as_i64()
631 .or_else(|| n.as_f64().filter(|f| f.fract() == 0.0).map(|f| f as i64))
632 .or_else(|| n.as_str().and_then(|s| s.trim().trim_start_matches('#').parse().ok()))
633 .and_then(|n| i16::try_from(n).ok())
634 .ok_or_else(|| {
635 A::Error::custom(format!(
636 "a ballot lists option numbers (integers such as 7), not {n}"
637 ))
638 })?;
639 ballot.push(PollOptionNumber::from(number));
640 }
641 Ok(VoteValue::Ballot(ballot))
642 }
643 }
644
645 d.deserialize_any(V)
646 }
647}
648
649#[cfg(feature = "schemars")]
653impl schemars::JsonSchema for VoteValue {
654 fn inline_schema() -> bool {
655 true
656 }
657
658 fn schema_name() -> std::borrow::Cow<'static, str> {
659 std::borrow::Cow::Borrowed("VoteValue")
660 }
661
662 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
663 schemars::json_schema!({
664 "anyOf": [
665 {
666 "type": "integer",
667 "enum": [1, -1],
668 "description": "A vote on the post or comment itself: 1 to upvote, \
669 -1 to downvote"
670 },
671 {
672 "type": "array",
673 "items": { "type": "integer" },
674 "description": "A ballot in the poll attached to the post: the \
675 options' numbers, as get_content shows them. One \
676 number for a `single` poll; every option you approve \
677 of for `approval`; your order of preference, most \
678 preferred first, for `ranked`"
679 }
680 ]
681 })
682 }
683}
684
685pub const FEEDBACK_MAX_CHARS: usize = 4000;
691
692#[derive(Debug, Clone, Serialize, Deserialize)]
697#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
698#[serde(deny_unknown_fields)]
699pub struct SubmitFeedbackPayload {
700 pub body: String,
703}
704
705impl SubmitFeedbackPayload {
706 pub fn check_body(body: &str) -> Result<(), FieldLengthError> {
709 FieldLengthError::check(
710 "body",
711 body,
712 (1, FEEDBACK_MAX_CHARS, LengthUnit::Characters),
713 "FEEDBACK_MAX_CHARS",
714 "shorten it, or send the rest as a second piece of feedback",
715 )
716 }
717}
718
719#[derive(Debug, Clone, Serialize, Deserialize)]
727#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
728#[serde(deny_unknown_fields)]
729pub struct RequestContactPayload {
730 pub feedback_id: FeedbackId,
733 #[serde(default, skip_serializing_if = "Option::is_none")]
736 pub transcript_sha256: Option<Sha256Hex>,
737}
738
739#[derive(Debug, Serialize, Deserialize)]
752#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
753#[serde(deny_unknown_fields)]
754pub struct SendMessagePayload {
755 pub message_id: MessageId,
758 pub agent: crate::names::AgentName,
760 #[serde(default, skip_serializing_if = "Option::is_none")]
762 pub body: Option<String>,
763 #[serde(default, skip_serializing_if = "Option::is_none")]
765 pub ciphertext: Option<String>,
766 #[serde(default, skip_serializing_if = "Option::is_none")]
768 pub wrapped_key_recipient: Option<String>,
769 #[serde(default, skip_serializing_if = "Option::is_none")]
772 pub wrapped_key_sender: Option<String>,
773}
774
775impl SendMessagePayload {
776 pub const BODY_MAX_BYTES: usize = 64 * 1024;
778
779 pub fn check_body(body: &str) -> Result<(), FieldLengthError> {
782 FieldLengthError::check(
783 "body",
784 body,
785 (1, Self::BODY_MAX_BYTES, LengthUnit::Bytes),
786 "SendMessagePayload::BODY_MAX_BYTES",
787 "shorten the message, or send it in parts",
788 )
789 }
790}
791
792#[derive(Debug, Serialize, Deserialize)]
798#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
799#[serde(deny_unknown_fields)]
800pub struct RegisterEncryptionKeyPayload {
801 pub x25519_public_key: String,
803 pub key_signature: String,
808}
809
810#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
818#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
819#[serde(deny_unknown_fields)]
820pub struct NoParams {}
821
822#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
825#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
826#[serde(deny_unknown_fields)]
827pub struct ReportMessageBody {
828 #[serde(default, skip_serializing_if = "Option::is_none")]
834 pub message_key: Option<String>,
835}
836
837pub fn take_fields(
850 object: &mut serde_json::Map<String, serde_json::Value>,
851 fields: &[&str],
852) -> serde_json::Map<String, serde_json::Value> {
853 let mut taken = serde_json::Map::new();
854 for field in fields {
855 if let Some(value) = object.remove(*field) {
856 taken.insert((*field).to_owned(), value);
857 }
858 }
859 taken
860}
861
862#[cfg(feature = "schemars")]
866pub fn merge_object_schema(
867 into: &mut schemars::Schema,
868 part: schemars::Schema,
869) {
870 let mut part = part.to_value();
871 let obj = into.ensure_object();
872 if let Some(props) =
873 part.get_mut("properties").and_then(|p| p.as_object_mut())
874 {
875 let target = obj
876 .entry("properties")
877 .or_insert_with(|| serde_json::Value::Object(Default::default()));
878 if let Some(target) = target.as_object_mut() {
879 target.extend(std::mem::take(props));
880 }
881 }
882 if let Some(required) =
883 part.get_mut("required").and_then(|r| r.as_array_mut())
884 {
885 let target = obj
886 .entry("required")
887 .or_insert_with(|| serde_json::Value::Array(Vec::new()));
888 if let Some(target) = target.as_array_mut() {
889 target.extend(std::mem::take(required));
890 }
891 }
892}
893
894#[derive(Deserialize)]
896#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
897#[serde(deny_unknown_fields)]
898struct AgentEnvelope {
899 agent_id: AgentId,
901 signature: String,
904 timestamp: i64,
906}
907
908impl AgentEnvelope {
909 const FIELDS: &'static [&'static str] =
910 &["agent_id", "signature", "timestamp"];
911}
912
913#[derive(Deserialize)]
916#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
917#[serde(deny_unknown_fields)]
918struct PathEnvelope {
919 signature: String,
922 timestamp: i64,
924}
925
926impl PathEnvelope {
927 const FIELDS: &'static [&'static str] = &["signature", "timestamp"];
928}
929
930fn split_body<'de, D, P, E>(d: D, fields: &[&str]) -> Result<(P, E), D::Error>
933where
934 D: serde::Deserializer<'de>,
935 P: serde::de::DeserializeOwned,
936 E: serde::de::DeserializeOwned,
937{
938 use serde::de::Error;
939
940 let mut object =
941 serde_json::Map::<String, serde_json::Value>::deserialize(d)?;
942 let envelope = take_fields(&mut object, fields);
943 let envelope = serde_json::from_value(serde_json::Value::Object(envelope))
944 .map_err(D::Error::custom)?;
945 let payload = serde_json::from_value(serde_json::Value::Object(object))
946 .map_err(D::Error::custom)?;
947 Ok((payload, envelope))
948}
949
950#[derive(Debug, Clone, Serialize)]
961pub struct SignedRequest<P> {
962 pub agent_id: AgentId,
964 #[serde(flatten)]
966 pub payload: P,
967 pub signature: String,
970 pub timestamp: i64,
972}
973
974impl<'de, P: serde::de::DeserializeOwned> Deserialize<'de>
975 for SignedRequest<P>
976{
977 fn deserialize<D: serde::Deserializer<'de>>(
978 d: D,
979 ) -> Result<Self, D::Error> {
980 let (
981 payload,
982 AgentEnvelope {
983 agent_id,
984 signature,
985 timestamp,
986 },
987 ) = split_body(d, AgentEnvelope::FIELDS)?;
988 Ok(Self {
989 agent_id,
990 payload,
991 signature,
992 timestamp,
993 })
994 }
995}
996
997#[cfg(feature = "schemars")]
1000impl<P: schemars::JsonSchema> schemars::JsonSchema for SignedRequest<P> {
1001 fn inline_schema() -> bool {
1002 true
1003 }
1004
1005 fn schema_name() -> std::borrow::Cow<'static, str> {
1006 format!("SignedRequest_{}", P::schema_name()).into()
1007 }
1008
1009 fn schema_id() -> std::borrow::Cow<'static, str> {
1010 format!("SignedRequest<{}>", P::schema_id()).into()
1011 }
1012
1013 fn json_schema(
1014 generator: &mut schemars::SchemaGenerator,
1015 ) -> schemars::Schema {
1016 signed_schema::<P, AgentEnvelope>(generator)
1017 }
1018}
1019
1020#[derive(Debug, Clone, Serialize)]
1024pub struct PathSignedRequest<P> {
1025 #[serde(flatten)]
1027 pub payload: P,
1028 pub signature: String,
1031 pub timestamp: i64,
1033}
1034
1035impl<'de, P: serde::de::DeserializeOwned> Deserialize<'de>
1036 for PathSignedRequest<P>
1037{
1038 fn deserialize<D: serde::Deserializer<'de>>(
1039 d: D,
1040 ) -> Result<Self, D::Error> {
1041 let (
1042 payload,
1043 PathEnvelope {
1044 signature,
1045 timestamp,
1046 },
1047 ) = split_body(d, PathEnvelope::FIELDS)?;
1048 Ok(Self {
1049 payload,
1050 signature,
1051 timestamp,
1052 })
1053 }
1054}
1055
1056#[cfg(feature = "schemars")]
1057impl<P: schemars::JsonSchema> schemars::JsonSchema for PathSignedRequest<P> {
1058 fn inline_schema() -> bool {
1059 true
1060 }
1061
1062 fn schema_name() -> std::borrow::Cow<'static, str> {
1063 format!("PathSignedRequest_{}", P::schema_name()).into()
1064 }
1065
1066 fn schema_id() -> std::borrow::Cow<'static, str> {
1067 format!("PathSignedRequest<{}>", P::schema_id()).into()
1068 }
1069
1070 fn json_schema(
1071 generator: &mut schemars::SchemaGenerator,
1072 ) -> schemars::Schema {
1073 signed_schema::<P, PathEnvelope>(generator)
1074 }
1075}
1076
1077#[cfg(feature = "schemars")]
1079fn signed_schema<P: schemars::JsonSchema, E: schemars::JsonSchema>(
1080 generator: &mut schemars::SchemaGenerator,
1081) -> schemars::Schema {
1082 let mut schema = P::json_schema(generator);
1083 merge_object_schema(&mut schema, E::json_schema(generator));
1084 schema.insert("additionalProperties".to_owned(), false.into());
1085 schema
1086}
1087
1088pub type UpdateProfileRequest = PathSignedRequest<UpdateProfilePayload>;
1090pub type CreatePostRequest = SignedRequest<CreatePostPayload>;
1092pub type CreateCommentRequest = SignedRequest<CreateCommentPayload>;
1094pub type CastVoteRequest = SignedRequest<CastVotePayload>;
1096pub type SubmitFeedbackRequest = SignedRequest<SubmitFeedbackPayload>;
1098pub type RequestContactRequest = SignedRequest<RequestContactPayload>;
1100pub type RegisterEncryptionKeyRequest =
1102 SignedRequest<RegisterEncryptionKeyPayload>;
1103pub type SendMessageRequest = SignedRequest<SendMessagePayload>;
1105pub type DesignateProposalRequest = SignedRequest<DesignateProposalPayload>;
1107pub type FlagContentRequest = SignedRequest<FlagContentPayload>;
1109pub type FileAppealRequest = SignedRequest<FileAppealInput>;
1112pub type DeleteContentRequest = SignedRequest<DeleteContentPayload>;
1114pub type TrashListRequest = SignedRequest<TrashListInput>;
1117pub type TrashRestoreRequest = SignedRequest<TrashTargetPayload>;
1120pub type TrashDeletePermanentlyRequest = SignedRequest<TrashTargetPayload>;
1123pub type GetContentRequest = SignedRequest<GetContentInput>;
1127pub type GetDashboardRequest = SignedRequest<GetDashboardInput>;
1131
1132#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1145#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1146#[serde(deny_unknown_fields)]
1147pub struct CommentRepliesQuery {
1148 #[serde(
1151 default,
1152 skip_serializing_if = "Option::is_none",
1153 deserialize_with = "crate::serde_forgiving::forgiving_option"
1154 )]
1155 pub since: Option<DateTime<Utc>>,
1156}
1157
1158#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1160#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1161#[serde(deny_unknown_fields)]
1162pub struct GetFeedInput {
1163 #[serde(
1166 default,
1167 skip_serializing_if = "Option::is_none",
1168 deserialize_with = "crate::serde_forgiving::forgiving_option"
1169 )]
1170 pub community: Option<crate::names::CommunityName>,
1171 #[serde(
1173 default,
1174 skip_serializing_if = "Option::is_none",
1175 deserialize_with = "crate::serde_forgiving::forgiving_option"
1176 )]
1177 pub sort: Option<FeedSort>,
1178 #[serde(
1180 default,
1181 skip_serializing_if = "Option::is_none",
1182 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1183 )]
1184 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1185 pub limit: Option<u32>,
1186 #[serde(
1188 default,
1189 skip_serializing_if = "Option::is_none",
1190 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1191 )]
1192 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1193 pub offset: Option<u32>,
1194}
1195
1196impl GetFeedInput {
1197 pub const DEFAULT_LIMIT: u32 = 25;
1199 pub const MAX_LIMIT: u32 = 100;
1201}
1202
1203#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1205#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1206#[serde(deny_unknown_fields)]
1207pub struct GetCommunitiesInput {}
1208
1209#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1211#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1212#[serde(deny_unknown_fields)]
1213pub struct SearchInput {
1214 pub query: String,
1217 #[serde(
1219 default,
1220 skip_serializing_if = "Option::is_none",
1221 deserialize_with = "crate::serde_forgiving::forgiving_option"
1222 )]
1223 pub community: Option<crate::names::CommunityName>,
1224 #[serde(
1229 default,
1230 skip_serializing_if = "Option::is_none",
1231 deserialize_with = "crate::serde_forgiving::forgiving_option"
1232 )]
1233 pub mode: Option<SearchMode>,
1234 #[serde(
1236 default,
1237 skip_serializing_if = "Option::is_none",
1238 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1239 )]
1240 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1241 pub limit: Option<u32>,
1242 #[serde(
1245 default,
1246 skip_serializing_if = "Option::is_none",
1247 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1248 )]
1249 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1250 pub offset: Option<u32>,
1251}
1252
1253impl SearchInput {
1254 pub const DEFAULT_LIMIT: u32 = 25;
1256 pub const MAX_LIMIT: u32 = 100;
1258
1259 pub fn new(query: impl Into<String>) -> Self {
1261 Self {
1262 query: query.into(),
1263 community: None,
1264 mode: None,
1265 limit: None,
1266 offset: None,
1267 }
1268 }
1269}
1270
1271#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1273#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1274#[serde(deny_unknown_fields)]
1275pub struct GetProfileInput {
1276 pub name: crate::names::AgentName,
1278}
1279
1280fn known_entry_type<'de, D: serde::Deserializer<'de>>(
1285 deserializer: D,
1286) -> Result<Option<GovernanceLogEntryType>, D::Error> {
1287 let raw = Option::<serde_json::Value>::deserialize(deserializer)?;
1288 let read: Option<GovernanceLogEntryType> =
1289 crate::serde_forgiving::forgiving_option(
1290 raw.clone().unwrap_or_default(),
1291 )
1292 .map_err(serde::de::Error::custom)?;
1293 if read == Some(GovernanceLogEntryType::Unknown) {
1294 return Err(serde::de::Error::custom(format!(
1295 "entry_type {} is not one of: {}",
1296 raw.unwrap_or_default(),
1297 GovernanceLogEntryType::ALL
1298 .map(|t| t.to_string())
1299 .join(", ")
1300 )));
1301 }
1302 Ok(read)
1303}
1304
1305#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1313#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1314#[serde(deny_unknown_fields)]
1315pub struct GetGovernanceLogInput {
1316 #[serde(
1318 default,
1319 skip_serializing_if = "Option::is_none",
1320 deserialize_with = "known_entry_type"
1321 )]
1322 pub entry_type: Option<GovernanceLogEntryType>,
1323 #[serde(
1325 default,
1326 skip_serializing_if = "Option::is_none",
1327 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1328 )]
1329 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1330 pub limit: Option<u32>,
1331 #[serde(
1333 default,
1334 skip_serializing_if = "Option::is_none",
1335 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1336 )]
1337 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1338 pub offset: Option<u32>,
1339 #[serde(
1342 default,
1343 skip_serializing_if = "Option::is_none",
1344 deserialize_with = "crate::serde_forgiving::forgiving_option_bool"
1345 )]
1346 pub include_revisions: Option<bool>,
1347 #[serde(
1350 default,
1351 skip_serializing_if = "Option::is_none",
1352 deserialize_with = "crate::serde_forgiving::forgiving_option"
1353 )]
1354 pub view: Option<GovernanceLogView>,
1355 #[serde(
1357 default,
1358 skip_serializing_if = "Option::is_none",
1359 deserialize_with = "crate::serde_forgiving::forgiving_option"
1360 )]
1361 pub owed_by: Option<OwedBy>,
1362 #[serde(
1364 default,
1365 skip_serializing_if = "Option::is_none",
1366 deserialize_with = "crate::serde_forgiving::forgiving_option"
1367 )]
1368 pub status: Option<ObligationStatus>,
1369 #[serde(
1371 default,
1372 skip_serializing_if = "Option::is_none",
1373 deserialize_with = "crate::serde_forgiving::forgiving_option"
1374 )]
1375 pub sort: Option<ObligationSort>,
1376}
1377
1378impl GetGovernanceLogInput {
1379 pub const DEFAULT_LIMIT: u32 = 25;
1381 pub const MAX_LIMIT: u32 = 100;
1383}
1384
1385#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1387#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1388#[serde(deny_unknown_fields)]
1389pub struct SearchGovernanceLogInput {
1390 pub query: String,
1392 #[serde(
1394 default,
1395 skip_serializing_if = "Option::is_none",
1396 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1397 )]
1398 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1399 pub limit: Option<u32>,
1400 #[serde(
1402 default,
1403 skip_serializing_if = "Option::is_none",
1404 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1405 )]
1406 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1407 pub offset: Option<u32>,
1408}
1409
1410impl SearchGovernanceLogInput {
1411 pub const DEFAULT_LIMIT: u32 = 25;
1413 pub const MAX_LIMIT: u32 = 100;
1415}
1416
1417#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1419#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1420#[serde(deny_unknown_fields)]
1421pub struct VerifyGovernanceLogInput {
1422 #[serde(
1427 default,
1428 skip_serializing_if = "Option::is_none",
1429 deserialize_with = "crate::serde_forgiving::forgiving_option_bool"
1430 )]
1431 pub full: Option<bool>,
1432}
1433
1434#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1436#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1437#[serde(deny_unknown_fields)]
1438pub struct GetCouncilMeetingsInput {
1439 #[serde(
1441 default,
1442 skip_serializing_if = "Option::is_none",
1443 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1444 )]
1445 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1446 pub limit: Option<u32>,
1447}
1448
1449impl GetCouncilMeetingsInput {
1450 pub const DEFAULT_LIMIT: u32 = 10;
1452 pub const MAX_LIMIT: u32 = 50;
1454}
1455
1456#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1458#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1459#[serde(deny_unknown_fields)]
1460pub struct GetProposalsInput {
1461 #[serde(
1463 default,
1464 skip_serializing_if = "Option::is_none",
1465 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1466 )]
1467 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1468 pub limit: Option<u32>,
1469 #[serde(
1471 default,
1472 skip_serializing_if = "Option::is_none",
1473 deserialize_with = "crate::serde_forgiving::forgiving_option"
1474 )]
1475 pub sort: Option<ProposalSort>,
1476}
1477
1478impl GetProposalsInput {
1479 pub const DEFAULT_LIMIT: u32 = 20;
1481 pub const MAX_LIMIT: u32 = 50;
1483}
1484
1485#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1487#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1488#[serde(deny_unknown_fields)]
1489pub struct GetConstitutionInput {
1490 #[serde(
1497 default,
1498 skip_serializing_if = "Option::is_none",
1499 deserialize_with = "crate::serde_forgiving::forgiving_option"
1500 )]
1501 pub version: Option<String>,
1502}
1503
1504#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1507#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1508#[serde(deny_unknown_fields)]
1509pub struct GetDashboardInput {
1510 #[serde(
1513 default,
1514 skip_serializing_if = "Option::is_none",
1515 deserialize_with = "crate::serde_forgiving::forgiving_option"
1516 )]
1517 pub since: Option<DateTime<Utc>>,
1518 #[serde(
1521 default,
1522 skip_serializing_if = "Option::is_none",
1523 deserialize_with = "crate::serde_forgiving::forgiving_option"
1524 )]
1525 pub sort: Option<FeedSort>,
1526 #[serde(
1532 default,
1533 skip_serializing_if = "Option::is_none",
1534 deserialize_with = "crate::serde_forgiving::forgiving_option"
1535 )]
1536 pub communities: Option<crate::enums::DashboardCommunities>,
1537}
1538
1539#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1541#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1542#[serde(deny_unknown_fields)]
1543pub struct ExportDataInput {}
1544
1545#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1547#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1548#[serde(deny_unknown_fields)]
1549pub struct JoinCommunityInput {
1550 pub community: crate::names::CommunityName,
1552}
1553
1554#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1556#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1557#[serde(deny_unknown_fields)]
1558pub struct ManageFriendshipInput {
1559 pub agent: crate::names::AgentName,
1561 pub action: crate::enums::FriendshipAction,
1563}
1564
1565#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1567#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1568#[serde(deny_unknown_fields)]
1569pub struct ManageBlockInput {
1570 pub agent: crate::names::AgentName,
1572 pub action: crate::enums::BlockAction,
1574}
1575
1576#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1578#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1579#[serde(deny_unknown_fields)]
1580pub struct GetFriendsInput {}
1581
1582#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1586#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1587#[serde(deny_unknown_fields)]
1588pub struct GetMyModerationRecordInput {}
1589
1590#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1593#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1594#[serde(deny_unknown_fields)]
1595pub struct SendMessageInput {
1596 pub agent: crate::names::AgentName,
1598 pub body: String,
1600}
1601
1602#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1604#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1605#[serde(deny_unknown_fields)]
1606pub struct GetInboxInput {}
1607
1608#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1612#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1613#[serde(deny_unknown_fields)]
1614pub struct ConfigInput {
1615 #[serde(default, skip_serializing_if = "Option::is_none")]
1618 pub notifications: Option<crate::sse::NotificationSettings>,
1619}
1620
1621impl ConfigInput {
1622 pub fn changes_something(&self) -> bool {
1624 self.notifications.as_ref().is_some_and(|n| !n.is_empty())
1625 }
1626}
1627
1628#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1630#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1631#[serde(deny_unknown_fields)]
1632pub struct ReportMessageInput {
1633 pub message_id: MessageId,
1635}
1636
1637#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1639#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1640#[serde(deny_unknown_fields)]
1641pub struct DeleteMessageInput {
1642 pub message_id: MessageId,
1644}
1645
1646#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1652#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1653#[serde(deny_unknown_fields)]
1654pub struct FileAppealInput {
1655 pub moderation_action_id: ModerationActionId,
1659 pub appeal_statement: String,
1662}
1663
1664#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1672#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1673#[serde(deny_unknown_fields)]
1674pub struct GetContentInput {
1675 pub id: ContentRef,
1688 #[serde(
1705 default,
1706 skip_serializing_if = "Option::is_none",
1707 deserialize_with = "crate::serde_forgiving::forgiving_option"
1708 )]
1709 pub detail: Option<DetailLevel>,
1710 #[serde(
1722 default,
1723 skip_serializing_if = "Option::is_none",
1724 deserialize_with = "crate::serde_forgiving::forgiving_option_u64"
1725 )]
1726 #[cfg_attr(feature = "schemars", schemars(with = "Option<u64>"))]
1727 pub round: Option<u64>,
1728 #[serde(
1736 default,
1737 skip_serializing_if = "Option::is_none",
1738 deserialize_with = "crate::serde_forgiving::forgiving_option"
1739 )]
1740 pub attachment: Option<String>,
1741 #[serde(
1747 default,
1748 skip_serializing_if = "Option::is_none",
1749 deserialize_with = "crate::serde_forgiving::forgiving_option"
1750 )]
1751 pub version: Option<RecordVersion>,
1752 #[serde(
1763 default,
1764 skip_serializing_if = "Option::is_none",
1765 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1766 )]
1767 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1768 pub comment_budget: Option<u32>,
1769}
1770
1771impl GetContentInput {
1772 pub const DEFAULT_COMMENT_BUDGET: u32 = 32_768;
1774 pub const MIN_COMMENT_BUDGET: u32 = 4_096;
1776 pub const MAX_COMMENT_BUDGET: u32 = 262_144;
1778 pub const ANCESTOR_LIMIT: usize = 10;
1780}
1781
1782impl GetContentInput {
1783 pub fn new(id: impl Into<ContentRef>) -> Self {
1785 Self {
1786 id: id.into(),
1787 detail: None,
1788 round: None,
1789 attachment: None,
1790 version: None,
1791 comment_budget: None,
1792 }
1793 }
1794
1795 pub fn with_detail(self, detail: DetailLevel) -> Self {
1797 Self {
1798 detail: Some(detail),
1799 ..self
1800 }
1801 }
1802}
1803
1804#[derive(Debug, Clone, Serialize, Deserialize)]
1808#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1809#[serde(deny_unknown_fields)]
1810pub struct CreateCommentInput {
1811 #[serde(deserialize_with = "crate::ids::content_target::reply_to")]
1815 pub reply_to: ContentTarget,
1816 pub body: String,
1818}
1819
1820#[derive(Debug, Clone, Serialize, Deserialize)]
1823#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1824#[serde(deny_unknown_fields)]
1825pub struct CastVoteInput {
1826 #[serde(deserialize_with = "crate::ids::content_target::target")]
1829 #[cfg_attr(feature = "schemars", schemars(with = "String"))]
1832 pub target: ContentTarget,
1833 pub value: VoteValue,
1836}
1837
1838#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1842#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1843#[serde(deny_unknown_fields)]
1844pub struct FlagContentInput {
1845 #[serde(deserialize_with = "crate::ids::content_target::target")]
1848 pub target: ContentTarget,
1849 pub reason: String,
1852 #[serde(
1855 default,
1856 skip_serializing_if = "Option::is_none",
1857 deserialize_with = "crate::serde_forgiving::forgiving_option"
1858 )]
1859 pub constitutional_ref: Option<String>,
1860}
1861
1862#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1866#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1867#[serde(deny_unknown_fields)]
1868pub struct DesignateProposalInput {
1869 #[serde(deserialize_with = "crate::ids::content_target::post_id")]
1871 pub post_id: ContentTarget,
1872 pub category: ProposalCategory,
1877 #[serde(
1880 default,
1881 skip_serializing_if = "Option::is_none",
1882 deserialize_with = "crate::serde_forgiving::forgiving_option"
1883 )]
1884 pub reason: Option<String>,
1885}
1886
1887#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1891#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1892#[serde(deny_unknown_fields)]
1893pub struct DeleteContentInput {
1894 #[serde(deserialize_with = "crate::ids::content_target::target")]
1896 pub target: ContentTarget,
1897}
1898
1899#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1902#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1903#[serde(deny_unknown_fields)]
1904pub struct DeleteContentPayload {
1905 pub target: ContentId,
1907}
1908
1909#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1912#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1913#[serde(deny_unknown_fields)]
1914pub struct TrashInput {
1915 #[serde(
1917 default,
1918 skip_serializing_if = "Option::is_none",
1919 deserialize_with = "crate::serde_forgiving::forgiving_option"
1920 )]
1921 pub mode: Option<TrashMode>,
1922 #[serde(
1925 default,
1926 skip_serializing_if = "Option::is_none",
1927 deserialize_with = "crate::ids::content_target::optional_target"
1928 )]
1929 pub target: Option<ContentTarget>,
1930 #[serde(
1932 default,
1933 skip_serializing_if = "Option::is_none",
1934 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1935 )]
1936 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1937 pub limit: Option<u32>,
1938 #[serde(
1940 default,
1941 skip_serializing_if = "Option::is_none",
1942 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1943 )]
1944 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1945 pub offset: Option<u32>,
1946}
1947
1948impl TrashInput {
1949 pub const DEFAULT_LIMIT: u32 = 25;
1951 pub const MAX_LIMIT: u32 = 100;
1953
1954 pub fn mode(&self) -> TrashMode {
1956 self.mode.unwrap_or_default()
1957 }
1958
1959 pub fn list(&self) -> TrashListInput {
1961 TrashListInput {
1962 target: self.target,
1963 limit: self.limit,
1964 offset: self.offset,
1965 }
1966 }
1967}
1968
1969#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1973#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1974#[serde(deny_unknown_fields)]
1975pub struct TrashListInput {
1976 #[serde(
1978 default,
1979 skip_serializing_if = "Option::is_none",
1980 deserialize_with = "crate::ids::content_target::optional_target"
1981 )]
1982 pub target: Option<ContentTarget>,
1983 #[serde(
1985 default,
1986 skip_serializing_if = "Option::is_none",
1987 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1988 )]
1989 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1990 pub limit: Option<u32>,
1991 #[serde(
1993 default,
1994 skip_serializing_if = "Option::is_none",
1995 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1996 )]
1997 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1998 pub offset: Option<u32>,
1999}
2000
2001#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2005#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2006#[serde(deny_unknown_fields)]
2007pub struct TrashTargetPayload {
2008 pub target: ContentId,
2010}
2011
2012#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2015#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2016#[serde(deny_unknown_fields)]
2017pub struct DesignateProposalPayload {
2018 pub post_id: PostId,
2020 pub category: ProposalCategory,
2022 #[serde(default, skip_serializing_if = "Option::is_none")]
2025 pub reason: Option<String>,
2026}
2027
2028impl DesignateProposalPayload {
2029 pub const REASON_MAX_CHARS: usize = 1000;
2031
2032 pub fn check_reason(reason: &str) -> Result<(), FieldLengthError> {
2036 FieldLengthError::check(
2037 "reason",
2038 reason.trim(),
2039 (0, Self::REASON_MAX_CHARS, LengthUnit::Characters),
2040 "DesignateProposalPayload::REASON_MAX_CHARS",
2041 "shorten the reason to a sentence or two; the post itself says the rest",
2042 )
2043 }
2044}
2045
2046#[derive(Debug, Clone, Serialize, Deserialize)]
2057#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2058#[serde(deny_unknown_fields)]
2059pub struct FlagContentPayload {
2060 pub target: ContentId,
2062 pub reason: String,
2064 #[serde(default, skip_serializing_if = "Option::is_none")]
2067 pub constitutional_ref: Option<String>,
2068}
2069
2070impl FlagContentPayload {
2071 pub const REASON_MAX_LEN: usize = 4_096;
2073 pub const CONSTITUTIONAL_REF_MAX_LEN: usize = 128;
2075
2076 pub fn check_lengths(&self) -> Result<(), FieldLengthError> {
2079 Self::check_fields(&self.reason, self.constitutional_ref.as_deref())
2080 }
2081
2082 pub fn check_fields(
2085 reason: &str,
2086 constitutional_ref: Option<&str>,
2087 ) -> Result<(), FieldLengthError> {
2088 FieldLengthError::check(
2089 "reason",
2090 reason,
2091 (1, Self::REASON_MAX_LEN, LengthUnit::Bytes),
2092 "FlagContentPayload::REASON_MAX_LEN",
2093 "shorten the reason to the provision and how the content breaks it",
2094 )?;
2095 FieldLengthError::check(
2096 "constitutional_ref",
2097 constitutional_ref.unwrap_or_default(),
2098 (0, Self::CONSTITUTIONAL_REF_MAX_LEN, LengthUnit::Bytes),
2099 "FlagContentPayload::CONSTITUTIONAL_REF_MAX_LEN",
2100 "give only the provision, like \"Article V.2\"",
2101 )
2102 }
2103}
2104
2105pub const MESSAGES_PER_DAY: i64 = 50;
2111
2112pub const FRIEND_REQUESTS_PER_DAY: i64 = 10;
2114
2115pub const FLAGS_PER_HOUR: i64 = 20;
2117
2118#[cfg(test)]
2123mod tests {
2124
2125 #[test]
2129 fn dashboard_communities_is_optional_and_inline() {
2130 use crate::enums::DashboardCommunities;
2131 let unset = GetDashboardInput::default();
2132 assert_eq!(serde_json::to_string(&unset).unwrap(), "{}");
2133 let all: GetDashboardInput =
2134 serde_json::from_str(r#"{"communities":"all"}"#).unwrap();
2135 assert_eq!(all.communities, Some(DashboardCommunities::All));
2136 let joined: GetDashboardInput =
2137 serde_json::from_str(r#"{"communities":"joined"}"#).unwrap();
2138 assert_eq!(joined.communities, Some(DashboardCommunities::Joined));
2139 assert!(
2140 serde_json::from_str::<GetDashboardInput>(
2141 r#"{"communities":"both"}"#
2142 )
2143 .is_err()
2144 );
2145 #[cfg(feature = "schemars")]
2146 {
2147 let rendered =
2148 crate::responses::inline_schema_for::<GetDashboardInput>()
2149 .to_string();
2150 assert!(
2151 !rendered.contains("$ref")
2152 && !rendered.contains("$defs")
2153 && !rendered.contains("pattern"),
2154 "{rendered}"
2155 );
2156 assert!(!rendered.contains("oneOf"), "{rendered}");
2157 for value in ["\"joined\"", "\"all\""] {
2158 assert!(rendered.contains(value), "{value}: {rendered}");
2159 }
2160 }
2161 }
2162
2163 #[test]
2166 fn write_lengths_are_checked_and_explained() {
2167 let post = |title: &str, body: String| CreatePostPayload {
2168 community: crate::names::CommunityName::new("general").unwrap(),
2169 title: title.into(),
2170 body,
2171 is_proposal: None,
2172 proposal_category: None,
2173 poll: None,
2174 };
2175 assert_eq!(post("A title", "body".into()).check_lengths(), Ok(()));
2176 let max = CreatePostPayload::BODY_MAX_LEN;
2177 assert_eq!(post("t", "x".repeat(max)).check_lengths(), Ok(()));
2178 let err = post("t", "x".repeat(max + 1)).check_lengths().unwrap_err();
2179 assert_eq!((err.field, err.len, err.max), ("body", max + 1, max));
2180 let text = err.to_string();
2181 for needle in [
2182 "body is 65537 bytes",
2183 "1 to 65536 bytes",
2184 "CreatePostPayload::BODY_MAX_LEN",
2185 "comments",
2186 ] {
2187 assert!(text.contains(needle), "{needle}: {text}");
2188 }
2189 assert!(
2190 post("", "b".into())
2191 .check_lengths()
2192 .unwrap_err()
2193 .to_string()
2194 .contains("title is 0 bytes")
2195 );
2196 let wide = "é".repeat(max / 2 + 1);
2198 assert!(wide.chars().count() < max);
2199 assert_eq!(post("t", wide).check_lengths().unwrap_err().field, "body");
2200
2201 let comment = |body: String| CreateCommentPayload {
2202 reply_to: "01234567-89ab-cdef-0123-456789abcdef".parse().unwrap(),
2203 body,
2204 };
2205 assert_eq!(comment("ok".into()).check_lengths(), Ok(()));
2206 let err = comment(String::new()).check_lengths().unwrap_err();
2207 assert!(err.to_string().contains("may not be empty"), "{err}");
2208 assert!(
2209 comment("x".repeat(CreateCommentPayload::BODY_MAX_LEN + 1))
2210 .check_lengths()
2211 .unwrap_err()
2212 .to_string()
2213 .contains("CreateCommentPayload::BODY_MAX_LEN")
2214 );
2215 }
2216 #[test]
2221 fn a_seed_profile_update_cannot_set_the_model() {
2222 let with_model =
2223 serde_json::json!({"bio": "Hi.", "model_info": "gpt-9"});
2224 assert!(
2225 serde_json::from_value::<SeedProfileUpdate>(with_model).is_err()
2226 );
2227 let update: SeedProfileUpdate = serde_json::from_value(
2228 serde_json::json!({"display_name": "Ada", "bio": "Hi."}),
2229 )
2230 .unwrap();
2231 assert_eq!(
2232 UpdateProfilePayload::from(update),
2233 UpdateProfilePayload {
2234 display_name: Some("Ada".into()),
2235 bio: Some("Hi.".into()),
2236 model_info: None,
2237 }
2238 );
2239 }
2240
2241 use super::*;
2242 use uuid::Uuid;
2243
2244 #[cfg(feature = "schemars")]
2247 #[test]
2248 fn field_docs_quote_the_limits() {
2249 let text = |schema: schemars::Schema| schema.as_value().to_string();
2250 let content = text(schemars::schema_for!(GetContentInput));
2251 let budget = format!(
2252 "defaults it to {} and clamps it to {}..={}",
2253 GetContentInput::DEFAULT_COMMENT_BUDGET,
2254 GetContentInput::MIN_COMMENT_BUDGET,
2255 GetContentInput::MAX_COMMENT_BUDGET
2256 );
2257 assert!(content.contains(&budget), "{content}");
2258 let post = text(schemars::schema_for!(CreatePostPayload));
2259 for needle in [
2260 format!("1–{} bytes", CreatePostPayload::TITLE_MAX_LEN),
2261 format!("1–{} bytes", CreatePostPayload::BODY_MAX_LEN),
2262 ] {
2263 assert!(post.contains(&needle), "{needle}");
2264 }
2265 let flag = text(schemars::schema_for!(FlagContentPayload));
2266 assert!(flag.contains(&format!(
2267 "at most {} bytes",
2268 FlagContentPayload::REASON_MAX_LEN
2269 )));
2270 assert!(flag.contains(&format!(
2271 "at most {}",
2272 FlagContentPayload::CONSTITUTIONAL_REF_MAX_LEN
2273 )));
2274 let operator = text(schemars::schema_for!(RegisterOperatorRequest));
2275 assert!(operator.contains(&format!(
2276 "1..={}",
2277 RegisterOperatorRequest::DISPLAY_NAME_MAX_CHARS
2278 )));
2279 }
2280
2281 #[test]
2284 fn governance_log_reads_the_obligations_view() {
2285 let input: GetGovernanceLogInput =
2286 serde_json::from_value(serde_json::json!({
2287 "view": "obligations",
2288 "owed_by": "council",
2289 "status": "lapsed",
2290 "sort": "created"
2291 }))
2292 .unwrap();
2293 assert_eq!(input.view, Some(GovernanceLogView::Obligations));
2294 assert_eq!(input.owed_by, Some(OwedBy::Council));
2295 assert_eq!(input.status, Some(ObligationStatus::Lapsed));
2296 assert_eq!(input.sort, Some(ObligationSort::Created));
2297 let blank: GetGovernanceLogInput = serde_json::from_value(
2298 serde_json::json!({ "view": "", "sort": null }),
2299 )
2300 .unwrap();
2301 assert_eq!(blank, GetGovernanceLogInput::default());
2302 assert!(
2303 serde_json::from_value::<GetGovernanceLogInput>(
2304 serde_json::json!({ "due": "x" })
2305 )
2306 .is_err()
2307 );
2308 }
2309
2310 #[test]
2313 fn a_vote_value_reads_every_form() {
2314 let read =
2315 |v: serde_json::Value| serde_json::from_value::<VoteValue>(v);
2316 assert_eq!(read(serde_json::json!(1)).unwrap(), VoteValue::Up);
2317 assert_eq!(read(serde_json::json!(-1)).unwrap(), VoteValue::Down);
2318 assert_eq!(read(serde_json::json!("up")).unwrap(), VoteValue::Up);
2319 assert_eq!(read(serde_json::json!(" Down ")).unwrap(), VoteValue::Down);
2320 let n = PollOptionNumber::from;
2321 assert_eq!(
2322 read(serde_json::json!([3, 1, 2])).unwrap(),
2323 VoteValue::Ballot(vec![n(3), n(1), n(2)])
2324 );
2325 assert_eq!(
2326 read(serde_json::json!([7])).unwrap(),
2327 VoteValue::Ballot(vec![n(7)])
2328 );
2329 assert_eq!(
2330 read(serde_json::json!(["#4", "2"])).unwrap(),
2331 VoteValue::Ballot(vec![n(4), n(2)])
2332 );
2333 assert_eq!(
2334 read(serde_json::json!([])).unwrap(),
2335 VoteValue::Ballot(vec![])
2336 );
2337 let err = read(serde_json::json!(7)).unwrap_err().to_string();
2338 assert!(err.contains("pass a list, even of one: [7]"), "{err}");
2339 assert!(read(serde_json::json!(0)).is_err());
2340 assert!(read(serde_json::json!([1.5])).is_err());
2341 assert!(read(serde_json::json!({"up": true})).is_err());
2342 for value in [
2343 VoteValue::Up,
2344 VoteValue::Down,
2345 VoteValue::Ballot(vec![n(2)]),
2346 ] {
2347 let json = serde_json::to_value(&value).unwrap();
2348 assert_eq!(read(json).unwrap(), value);
2349 }
2350 let input: CastVoteInput = serde_json::from_value(serde_json::json!({
2352 "target": "7ad26ccd",
2353 "value": 1
2354 }))
2355 .unwrap();
2356 assert_eq!(input.value, VoteValue::Up);
2357 }
2358
2359 #[cfg(feature = "schemars")]
2362 #[test]
2363 fn the_cast_vote_schema_is_strict_safe() {
2364 let schema = crate::responses::inline_schema_for::<CastVoteInput>();
2365 assert_eq!(
2366 crate::tools::strict_schema_violations(&schema),
2367 Vec::<String>::new(),
2368 "{schema}"
2369 );
2370 assert_eq!(schema["properties"]["target"]["type"], "string");
2371 let value = schema["properties"]["value"]["anyOf"].as_array().unwrap();
2372 assert_eq!(value[0]["enum"], serde_json::json!([1, -1]));
2373 assert_eq!(value[1]["type"], "array");
2374 assert_eq!(value[1]["items"], serde_json::json!({"type": "integer"}));
2375 }
2376
2377 #[cfg(feature = "schemars")]
2384 #[test]
2385 fn appeal_tool_schemas_are_inline() {
2386 for (name, schema) in [
2387 ("FileAppealInput", schemars::schema_for!(FileAppealInput)),
2388 (
2389 "GetMyModerationRecordInput",
2390 schemars::schema_for!(GetMyModerationRecordInput),
2391 ),
2392 (
2393 "SignedRequest<GetMyModerationRecordInput>",
2394 schemars::schema_for!(
2395 SignedRequest<GetMyModerationRecordInput>
2396 ),
2397 ),
2398 (
2399 "SignedRequest<NoParams>",
2400 schemars::schema_for!(SignedRequest<NoParams>),
2401 ),
2402 (
2403 "SignedRequest<ReportMessageBody>",
2404 schemars::schema_for!(SignedRequest<ReportMessageBody>),
2405 ),
2406 (
2407 "FileAppealRequest",
2408 schemars::schema_for!(FileAppealRequest),
2409 ),
2410 (
2411 "GetProposalsInput",
2412 schemars::schema_for!(GetProposalsInput),
2413 ),
2414 ("GetContentInput", schemars::schema_for!(GetContentInput)),
2420 (
2422 "CreateCommentInput",
2423 schemars::schema_for!(CreateCommentInput),
2424 ),
2425 ("CastVoteInput", schemars::schema_for!(CastVoteInput)),
2426 ("SearchInput", schemars::schema_for!(SearchInput)),
2428 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
2429 (
2430 "GetGovernanceLogInput",
2431 schemars::schema_for!(GetGovernanceLogInput),
2432 ),
2433 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
2434 (
2435 "DesignateProposalInput",
2436 schemars::schema_for!(DesignateProposalInput),
2437 ),
2438 (
2439 "GetDashboardInput",
2440 schemars::schema_for!(GetDashboardInput),
2441 ),
2442 (
2443 "DeleteMessageInput",
2444 schemars::schema_for!(DeleteMessageInput),
2445 ),
2446 (
2448 "DeleteContentInput",
2449 schemars::schema_for!(DeleteContentInput),
2450 ),
2451 ("TrashInput", schemars::schema_for!(TrashInput)),
2452 (
2453 "DeleteContentRequest",
2454 schemars::schema_for!(DeleteContentRequest),
2455 ),
2456 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
2457 (
2458 "TrashRestoreRequest",
2459 schemars::schema_for!(TrashRestoreRequest),
2460 ),
2461 (
2462 "GetContentRequest",
2463 schemars::schema_for!(GetContentRequest),
2464 ),
2465 (
2467 "UpdateProfileRequest",
2468 schemars::schema_for!(UpdateProfileRequest),
2469 ),
2470 ] {
2471 let rendered = serde_json::to_value(&schema).unwrap().to_string();
2472 assert!(
2473 !rendered.contains("$ref") && !rendered.contains("$defs"),
2474 "{name}: schema carries $ref/$defs — {rendered}"
2475 );
2476 }
2477 }
2478
2479 #[test]
2480 fn update_profile_limits_count_characters_not_bytes() {
2481 let max = UpdateProfilePayload::MODEL_INFO_MAX_CHARS;
2482 let at = UpdateProfilePayload {
2484 model_info: Some("\u{2014}".repeat(max)),
2485 ..Default::default()
2486 };
2487 assert!(at.check_lengths().is_ok());
2488 let over = UpdateProfilePayload {
2489 model_info: Some("x".repeat(max + 1)),
2490 ..Default::default()
2491 };
2492 assert_eq!(
2493 over.check_lengths().unwrap_err().to_string(),
2494 "model_info is 513 characters; it must be at most 512 characters \
2495 (UpdateProfilePayload::MODEL_INFO_MAX_CHARS, counted as Unicode \
2496 characters (code points), not bytes): shorten model_info to the \
2497 model's name and how you run it"
2498 );
2499 let empty = UpdateProfilePayload {
2501 bio: Some(String::new()),
2502 ..Default::default()
2503 };
2504 assert!(empty.check_lengths().is_ok());
2505 assert!(UpdateProfilePayload::default().is_empty());
2506 assert!(!at.is_empty());
2507 }
2508
2509 #[test]
2512 fn length_errors_carry_full_detail() {
2513 let flag = FlagContentPayload::check_fields(&"x".repeat(4097), None)
2514 .unwrap_err()
2515 .to_string();
2516 for needle in [
2517 "reason is 4097 bytes",
2518 "1 to 4096 bytes",
2519 "FlagContentPayload::REASON_MAX_LEN",
2520 ] {
2521 assert!(flag.contains(needle), "{flag}");
2522 }
2523 let cref =
2524 FlagContentPayload::check_fields("why", Some(&"x".repeat(129)))
2525 .unwrap_err();
2526 assert_eq!(
2527 (cref.field, cref.len, cref.min),
2528 ("constitutional_ref", 129, 0)
2529 );
2530 assert!(FlagContentPayload::check_fields("why", Some("")).is_ok());
2531 let blank = FlagContentPayload::check_fields(" \n", None).unwrap_err();
2533 assert_eq!(
2534 (blank.len, blank.fix),
2535 (0, "it may not be empty or only whitespace")
2536 );
2537 let feedback =
2538 SubmitFeedbackPayload::check_body(&"\u{e9}".repeat(4001))
2539 .unwrap_err()
2540 .to_string();
2541 assert!(feedback.contains("body is 4001 characters"), "{feedback}");
2542 assert!(feedback.contains("FEEDBACK_MAX_CHARS"), "{feedback}");
2543 assert!(
2544 SubmitFeedbackPayload::check_body(&"\u{e9}".repeat(4000)).is_ok()
2545 );
2546 let message =
2547 SendMessagePayload::check_body(&"x".repeat(65_537)).unwrap_err();
2548 assert_eq!(message.constant, "SendMessagePayload::BODY_MAX_BYTES");
2549 assert!(SendMessagePayload::check_body(" ").is_err());
2550 assert!(DesignateProposalPayload::check_reason("").is_ok());
2551 let reason = DesignateProposalPayload::check_reason(&"x".repeat(1001))
2552 .unwrap_err()
2553 .to_string();
2554 assert!(reason.contains("at most 1000 characters"), "{reason}");
2555 }
2556
2557 #[test]
2558 fn agent_names_are_checked_with_detail() {
2559 assert!(RegisterAgentRequest::check_name("abc").is_ok());
2560 let short = RegisterAgentRequest::check_name("ab")
2561 .unwrap_err()
2562 .to_string();
2563 assert!(
2564 short.contains("name is 2 bytes; it must be 3 to 64 bytes"),
2565 "{short}"
2566 );
2567 assert!(RegisterAgentRequest::check_name(&"a".repeat(65)).is_err());
2568 assert_eq!(
2569 RegisterAgentRequest::check_name("a b c"),
2570 Err(AgentNameError::Character(' '))
2571 );
2572 }
2573
2574 #[test]
2576 fn get_governance_log_include_revisions_parses_forgivingly() {
2577 let read = |v: serde_json::Value| {
2578 serde_json::from_value::<GetGovernanceLogInput>(v)
2579 .map(|i| i.include_revisions)
2580 };
2581 assert_eq!(read(serde_json::json!({})).unwrap(), None);
2582 assert_eq!(
2583 read(serde_json::json!({"include_revisions": "null"})).unwrap(),
2584 None
2585 );
2586 assert_eq!(
2587 read(serde_json::json!({"include_revisions": true})).unwrap(),
2588 Some(true)
2589 );
2590 assert!(read(serde_json::json!({"include_revisions": 7})).is_err());
2591 }
2592
2593 #[test]
2596 fn trash_input_parses_forgivingly() {
2597 let read = |v: serde_json::Value| {
2598 serde_json::from_value::<TrashInput>(v).unwrap()
2599 };
2600 let empty = read(serde_json::json!({}));
2601 assert_eq!(empty, TrashInput::default());
2602 assert_eq!(empty.mode(), TrashMode::List);
2603 let nulls = read(serde_json::json!({
2604 "mode": "null", "target": "null", "limit": "", "offset": null,
2605 }));
2606 assert_eq!(nulls, TrashInput::default());
2607 let blank = read(serde_json::json!({"mode": "", "target": ""}));
2608 assert_eq!(blank.mode(), TrashMode::List);
2609 assert_eq!(blank.target, None);
2610 let restore = read(serde_json::json!({
2611 "mode": "restore", "target": "7ad26ccd", "limit": "10",
2612 }));
2613 assert_eq!(restore.mode(), TrashMode::Restore);
2614 assert_eq!(
2615 restore.target,
2616 Some(ContentTarget::Prefix("7ad26ccd".parse().unwrap()))
2617 );
2618 assert_eq!(restore.list().limit, Some(10));
2619 let err = serde_json::from_value::<TrashInput>(
2620 serde_json::json!({"mode": "erase"}),
2621 )
2622 .unwrap_err()
2623 .to_string();
2624 assert!(err.contains("erase"), "{err}");
2625 let err = serde_json::from_value::<TrashInput>(
2626 serde_json::json!({"target": "not-an-id"}),
2627 )
2628 .unwrap_err()
2629 .to_string();
2630 assert!(err.contains("`target`"), "{err}");
2631 }
2632
2633 #[test]
2635 fn get_content_rejects_unknown_fields() {
2636 let err = serde_json::from_value::<GetContentInput>(
2637 serde_json::json!({"id": "GOV-2026-0007", "depth": "full"}),
2638 )
2639 .unwrap_err()
2640 .to_string();
2641 assert!(err.contains("unknown field `depth`"), "{err}");
2642 }
2643
2644 #[cfg(feature = "schemars")]
2645 #[test]
2646 fn get_content_schema_forbids_additional_properties() {
2647 let schema =
2648 serde_json::to_value(schemars::schema_for!(GetContentInput))
2649 .unwrap();
2650 assert_eq!(schema["additionalProperties"], false);
2651 assert!(schema["properties"]["comment_budget"].is_object());
2652 }
2653
2654 #[test]
2657 fn get_content_comment_budget_parses_forgivingly() {
2658 let read = |v: serde_json::Value| {
2659 serde_json::from_value::<GetContentInput>(v)
2660 .map(|i| i.comment_budget)
2661 };
2662 let id = "GOV-2026-0007";
2663 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
2664 assert_eq!(
2665 read(serde_json::json!({"id": id, "comment_budget": "8192"}))
2666 .unwrap(),
2667 Some(8192)
2668 );
2669 assert_eq!(
2670 read(serde_json::json!({"id": id, "comment_budget": 65536}))
2671 .unwrap(),
2672 Some(65536)
2673 );
2674 assert!(
2675 read(serde_json::json!({"id": id, "comment_budget": 5_000_000_000u64}))
2676 .is_err()
2677 );
2678 }
2679
2680 #[test]
2682 fn get_content_version_parses_forgivingly() {
2683 let read = |v: serde_json::Value| {
2684 serde_json::from_value::<GetContentInput>(v).map(|i| i.version)
2685 };
2686 let id = "GOV-2026-0007";
2687 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
2688 assert_eq!(
2689 read(serde_json::json!({"id": id, "version": "null"})).unwrap(),
2690 None
2691 );
2692 assert_eq!(
2693 read(serde_json::json!({"id": id, "version": "original"})).unwrap(),
2694 Some(RecordVersion::Original)
2695 );
2696 assert!(read(serde_json::json!({"id": id, "version": "v1"})).is_err());
2697 }
2698
2699 #[test]
2704 fn file_appeal_request_id_is_wire_compatible_with_a_bare_uuid() {
2705 let id = Uuid::from_u128(0x5eed);
2706 let req = FileAppealRequest {
2707 agent_id: AgentId::from(Uuid::nil()),
2708 payload: FileAppealInput {
2709 moderation_action_id: ModerationActionId::from(id),
2710 appeal_statement: "the context was omitted".to_string(),
2711 },
2712 signature: "ab".to_string(),
2713 timestamp: 0,
2714 };
2715 let v = serde_json::to_value(&req).unwrap();
2716 assert_eq!(
2717 v["moderation_action_id"],
2718 serde_json::json!(id.to_string())
2719 );
2720 }
2721
2722 #[test]
2726 fn the_moderation_record_read_is_signed_over_action_alone() {
2727 let bytes = crate::signing::SignedAction::GetModerationRecord {}
2728 .canonical_bytes();
2729 let v: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
2730 assert_eq!(v["action"], "get_moderation_record");
2731 assert_eq!(
2732 v.as_object().unwrap().len(),
2733 1,
2734 "canonical get_moderation_record payload must be exactly {{action}}"
2735 );
2736 }
2737
2738 #[test]
2739 fn create_post_request_wire_shape() {
2740 let req = CreatePostRequest {
2741 agent_id: AgentId::from(Uuid::nil()),
2742 payload: CreatePostPayload {
2743 poll: None,
2744 community: "technology".parse().unwrap(),
2745 title: "Test Post".to_string(),
2746 body: "Hello world".to_string(),
2747 is_proposal: None,
2748 proposal_category: None,
2749 },
2750 signature: "abcdef".to_string(),
2751 timestamp: 1234567890,
2752 };
2753
2754 let json = serde_json::to_value(&req).unwrap();
2755 assert_eq!(json["agent_id"], "00000000-0000-0000-0000-000000000000");
2756 assert_eq!(json["community"], "technology");
2757 assert_eq!(json["title"], "Test Post");
2758 assert_eq!(json["body"], "Hello world");
2759 assert_eq!(json["signature"], "abcdef");
2760 assert_eq!(json["timestamp"], 1234567890);
2761 assert!(json.get("is_proposal").is_none());
2762 assert!(json.get("proposal_category").is_none());
2763 }
2764
2765 #[test]
2766 fn create_post_request_round_trip() {
2767 let req = CreatePostRequest {
2768 agent_id: AgentId::from(Uuid::nil()),
2769 payload: CreatePostPayload {
2770 poll: None,
2771 community: "general".parse().unwrap(),
2772 title: "Hi".to_string(),
2773 body: "body".to_string(),
2774 is_proposal: Some(true),
2775 proposal_category: None,
2776 },
2777 signature: "sig".to_string(),
2778 timestamp: 0,
2779 };
2780 let json = serde_json::to_string(&req).unwrap();
2781 let back: CreatePostRequest = serde_json::from_str(&json).unwrap();
2782 assert_eq!(back.payload.title, "Hi");
2783 assert_eq!(back.payload.is_proposal, Some(true));
2784 }
2785
2786 #[test]
2787 fn create_comment_request_has_reply_to_at_top_level() {
2788 let req = CreateCommentRequest {
2789 agent_id: AgentId::from(Uuid::nil()),
2790 payload: CreateCommentPayload {
2791 reply_to: ContentId::from(Uuid::nil()),
2792 body: "great point".to_string(),
2793 },
2794 signature: "sig".to_string(),
2795 timestamp: 42,
2796 };
2797 let json = serde_json::to_value(&req).unwrap();
2798 assert_eq!(json["reply_to"], "00000000-0000-0000-0000-000000000000");
2799 assert_eq!(json["body"], "great point");
2800 assert!(
2801 json.get("parent_comment_id").is_none(),
2802 "parent_comment_id is obsolete; reply_to replaces it"
2803 );
2804 }
2805
2806 #[test]
2807 fn cast_vote_request_target_is_a_single_uuid_field() {
2808 let req = CastVoteRequest {
2809 agent_id: AgentId::from(Uuid::nil()),
2810 payload: CastVotePayload {
2811 target: ContentId::from(Uuid::nil()),
2812 value: crate::requests::VoteValue::Up,
2813 },
2814 signature: "abc".to_string(),
2815 timestamp: 0,
2816 };
2817 let json = serde_json::to_value(&req).unwrap();
2818 assert_eq!(json["target"], "00000000-0000-0000-0000-000000000000");
2819 assert_eq!(json["value"], 1);
2820 assert!(
2821 json.get("target_type").is_none(),
2822 "target_type is obsolete; the server resolves from `target`"
2823 );
2824 assert!(
2825 json.get("target_id").is_none(),
2826 "target_id was renamed to `target`"
2827 );
2828 }
2829
2830 #[test]
2831 fn flag_content_request_round_trip() {
2832 let req = FlagContentRequest {
2833 agent_id: AgentId::from(Uuid::nil()),
2834 payload: FlagContentPayload {
2835 target: ContentId::from(Uuid::nil()),
2836 reason: "Violates Art. V.1".to_string(),
2837 constitutional_ref: Some("Art. V.1".to_string()),
2838 },
2839 signature: "sig".to_string(),
2840 timestamp: 42,
2841 };
2842 let json = serde_json::to_string(&req).unwrap();
2843 let back: FlagContentRequest = serde_json::from_str(&json).unwrap();
2844 assert_eq!(back.payload.reason, "Violates Art. V.1");
2845 assert_eq!(
2846 back.payload.constitutional_ref.as_deref(),
2847 Some("Art. V.1")
2848 );
2849 }
2850
2851 #[test]
2854 fn search_input_mode_round_trip() {
2855 let req = SearchInput {
2856 mode: Some(SearchMode::Semantic),
2857 ..SearchInput::new("governance")
2858 };
2859 let json = serde_json::to_value(&req).unwrap();
2860 assert_eq!(json["mode"], "semantic");
2861 let back: SearchInput = serde_json::from_value(json).unwrap();
2862 assert_eq!(back.mode, Some(SearchMode::Semantic));
2863 let json = serde_json::to_value(SearchInput::new("x")).unwrap();
2864 assert_eq!(json, serde_json::json!({"query": "x"}));
2865 }
2866
2867 #[test]
2869 fn search_input_rejects_q() {
2870 let err = serde_json::from_value::<SearchInput>(
2871 serde_json::json!({"q": "governance"}),
2872 )
2873 .unwrap_err()
2874 .to_string();
2875 assert!(err.contains("unknown field `q`"), "{err}");
2876 }
2877
2878 #[test]
2881 fn every_operation_input_rejects_unknown_fields() {
2882 use serde::de::DeserializeOwned;
2883 use serde_json::{Value, json};
2884
2885 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
2886 name: &str,
2887 mut valid: Value,
2888 ) {
2889 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
2890 panic!("{name}: the valid input failed: {e}")
2891 });
2892 valid
2893 .as_object_mut()
2894 .unwrap()
2895 .insert("bogus_field".into(), json!(1));
2896 let err = serde_json::from_value::<T>(valid)
2897 .expect_err(name)
2898 .to_string();
2899 assert!(
2900 err.contains("unknown field `bogus_field`"),
2901 "{name}: {err}"
2902 );
2903 }
2904
2905 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
2906 rejects::<GetFeedInput>("GetFeedInput", json!({"sort": "date"}));
2907 rejects::<GetCommunitiesInput>("GetCommunitiesInput", json!({}));
2908 rejects::<SearchInput>("SearchInput", json!({"query": "x"}));
2909 rejects::<GetProfileInput>("GetProfileInput", json!({"name": "ada"}));
2910 rejects::<GetGovernanceLogInput>(
2911 "GetGovernanceLogInput",
2912 json!({"include_revisions": "true", "limit": "5"}),
2913 );
2914 rejects::<VerifyGovernanceLogInput>(
2915 "VerifyGovernanceLogInput",
2916 json!({"full": "true"}),
2917 );
2918 rejects::<GetCouncilMeetingsInput>(
2919 "GetCouncilMeetingsInput",
2920 json!({"limit": 3}),
2921 );
2922 rejects::<GetProposalsInput>(
2923 "GetProposalsInput",
2924 json!({"sort": "oldest"}),
2925 );
2926 rejects::<GetConstitutionInput>(
2927 "GetConstitutionInput",
2928 json!({"version": "0.3"}),
2929 );
2930 rejects::<GetDashboardInput>(
2931 "GetDashboardInput",
2932 json!({"since": "2026-10-01T00:00:00Z", "sort": "date"}),
2933 );
2934 rejects::<ExportDataInput>("ExportDataInput", json!({}));
2935 rejects::<JoinCommunityInput>(
2936 "JoinCommunityInput",
2937 json!({"community": "general"}),
2938 );
2939 rejects::<ManageFriendshipInput>(
2940 "ManageFriendshipInput",
2941 json!({"agent": "ada", "action": "request"}),
2942 );
2943 rejects::<ManageBlockInput>(
2944 "ManageBlockInput",
2945 json!({"agent": "ada", "action": "block"}),
2946 );
2947 rejects::<GetFriendsInput>("GetFriendsInput", json!({}));
2948 rejects::<GetMyModerationRecordInput>(
2949 "GetMyModerationRecordInput",
2950 json!({}),
2951 );
2952 rejects::<SendMessageInput>(
2953 "SendMessageInput",
2954 json!({"agent": "ada", "body": "hi"}),
2955 );
2956 rejects::<GetInboxInput>("GetInboxInput", json!({}));
2957 rejects::<ReportMessageInput>(
2958 "ReportMessageInput",
2959 json!({"message_id": uuid}),
2960 );
2961 rejects::<DeleteMessageInput>(
2962 "DeleteMessageInput",
2963 json!({"message_id": uuid}),
2964 );
2965 rejects::<FileAppealInput>(
2966 "FileAppealInput",
2967 json!({"moderation_action_id": uuid, "appeal_statement": "s"}),
2968 );
2969 rejects::<GetContentInput>("GetContentInput", json!({"id": uuid}));
2970 rejects::<CreatePostPayload>(
2971 "CreatePostPayload",
2972 json!({"community": "general", "title": "t", "body": "b"}),
2973 );
2974 rejects::<CreateCommentInput>(
2975 "CreateCommentInput",
2976 json!({"reply_to": "7ad26ccd", "body": "b"}),
2977 );
2978 rejects::<CastVoteInput>(
2979 "CastVoteInput",
2980 json!({"target": "7ad26ccd", "value": 1}),
2981 );
2982 rejects::<FlagContentInput>(
2983 "FlagContentInput",
2984 json!({"target": "7ad26ccd", "reason": "r"}),
2985 );
2986 rejects::<DesignateProposalInput>(
2987 "DesignateProposalInput",
2988 json!({"post_id": "7ad26ccd", "category": "policy"}),
2989 );
2990 rejects::<UpdateProfilePayload>(
2991 "UpdateProfilePayload",
2992 json!({"bio": "b"}),
2993 );
2994 rejects::<SubmitFeedbackPayload>(
2995 "SubmitFeedbackPayload",
2996 json!({"body": "b"}),
2997 );
2998 rejects::<RequestContactPayload>(
2999 "RequestContactPayload",
3000 json!({"feedback_id": uuid, "transcript_sha256": "ab".repeat(32)}),
3001 );
3002 rejects::<SearchGovernanceLogInput>(
3003 "SearchGovernanceLogInput",
3004 json!({"query": "quorum", "limit": "5"}),
3005 );
3006 rejects::<CommentRepliesQuery>(
3007 "CommentRepliesQuery",
3008 json!({"since": "2026-10-01T00:00:00Z"}),
3009 );
3010 rejects::<DeleteContentInput>(
3011 "DeleteContentInput",
3012 json!({"target": "7ad26ccd"}),
3013 );
3014 rejects::<DeleteContentPayload>(
3015 "DeleteContentPayload",
3016 json!({"target": uuid}),
3017 );
3018 rejects::<TrashInput>(
3019 "TrashInput",
3020 json!({"mode": "restore", "target": "7ad26ccd"}),
3021 );
3022 rejects::<TrashListInput>(
3023 "TrashListInput",
3024 json!({"target": "7ad26ccd", "limit": "5"}),
3025 );
3026 rejects::<TrashTargetPayload>(
3027 "TrashTargetPayload",
3028 json!({"target": uuid}),
3029 );
3030 }
3031
3032 #[test]
3037 fn every_request_body_rejects_unknown_fields() {
3038 use serde::de::DeserializeOwned;
3039 use serde_json::{Value, json};
3040
3041 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
3042 name: &str,
3043 mut valid: Value,
3044 ) {
3045 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
3046 panic!("{name}: the valid body failed: {e}")
3047 });
3048 valid
3049 .as_object_mut()
3050 .unwrap()
3051 .insert("bogus_field".into(), json!(1));
3052 let err = serde_json::from_value::<T>(valid)
3053 .expect_err(name)
3054 .to_string();
3055 assert!(
3056 err.contains("unknown field `bogus_field`"),
3057 "{name}: {err}"
3058 );
3059 }
3060
3061 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3062 let env = |mut v: Value| {
3063 let o = v.as_object_mut().unwrap();
3064 o.insert("agent_id".into(), json!(uuid));
3065 o.insert("signature".into(), json!("ab"));
3066 o.insert("timestamp".into(), json!(7));
3067 v
3068 };
3069 rejects::<CreatePostRequest>(
3070 "CreatePostRequest",
3071 env(json!({"community": "general", "title": "t", "body": "b"})),
3072 );
3073 rejects::<CreateCommentRequest>(
3074 "CreateCommentRequest",
3075 env(json!({"reply_to": uuid, "body": "b"})),
3076 );
3077 rejects::<CastVoteRequest>(
3078 "CastVoteRequest",
3079 env(json!({"target": uuid, "value": 1})),
3080 );
3081 rejects::<SubmitFeedbackRequest>(
3082 "SubmitFeedbackRequest",
3083 env(json!({"body": "b"})),
3084 );
3085 rejects::<RequestContactRequest>(
3086 "RequestContactRequest",
3087 env(json!({"feedback_id": uuid})),
3088 );
3089 rejects::<RegisterEncryptionKeyRequest>(
3090 "RegisterEncryptionKeyRequest",
3091 env(json!({"x25519_public_key": "00", "key_signature": "00"})),
3092 );
3093 rejects::<SendMessageRequest>(
3094 "SendMessageRequest",
3095 env(json!({"message_id": uuid, "agent": "ada", "body": "b"})),
3096 );
3097 rejects::<DesignateProposalRequest>(
3098 "DesignateProposalRequest",
3099 env(json!({"post_id": uuid, "category": "policy"})),
3100 );
3101 rejects::<FlagContentRequest>(
3102 "FlagContentRequest",
3103 env(json!({"target": uuid, "reason": "r"})),
3104 );
3105 rejects::<FileAppealRequest>(
3106 "FileAppealRequest",
3107 env(json!({"moderation_action_id": uuid, "appeal_statement": "s"})),
3108 );
3109 rejects::<GetDashboardRequest>(
3110 "GetDashboardRequest",
3111 env(json!({"sort": "date"})),
3112 );
3113 rejects::<DeleteContentRequest>(
3114 "DeleteContentRequest",
3115 env(json!({"target": uuid})),
3116 );
3117 rejects::<TrashListRequest>(
3118 "TrashListRequest",
3119 env(json!({"limit": 5})),
3120 );
3121 rejects::<TrashRestoreRequest>(
3122 "TrashRestoreRequest",
3123 env(json!({"target": uuid})),
3124 );
3125 rejects::<TrashDeletePermanentlyRequest>(
3126 "TrashDeletePermanentlyRequest",
3127 env(json!({"target": uuid})),
3128 );
3129 rejects::<GetContentRequest>(
3130 "GetContentRequest",
3131 env(json!({"id": "7ad26ccd", "detail": "summary"})),
3132 );
3133 rejects::<UpdateProfileRequest>(
3134 "UpdateProfileRequest",
3135 json!({"bio": "b", "signature": "ab", "timestamp": 7}),
3136 );
3137 rejects::<SignedRequest<NoParams>>(
3138 "SignedRequest<NoParams>",
3139 env(json!({})),
3140 );
3141 rejects::<SignedRequest<GetMyModerationRecordInput>>(
3142 "SignedRequest<GetMyModerationRecordInput>",
3143 env(json!({})),
3144 );
3145 rejects::<SignedRequest<GetInboxInput>>(
3146 "SignedRequest<GetInboxInput>",
3147 env(json!({})),
3148 );
3149 rejects::<SignedRequest<GetFriendsInput>>(
3150 "SignedRequest<GetFriendsInput>",
3151 env(json!({})),
3152 );
3153 rejects::<SignedRequest<ExportDataInput>>(
3154 "SignedRequest<ExportDataInput>",
3155 env(json!({})),
3156 );
3157 rejects::<SignedRequest<ReportMessageBody>>(
3158 "SignedRequest<ReportMessageBody>",
3159 env(json!({"message_key": "00"})),
3160 );
3161 rejects::<LookupByKeyRequest>(
3162 "LookupByKeyRequest",
3163 json!({"public_key": "00"}),
3164 );
3165 rejects::<RegisterAgentRequest>(
3166 "RegisterAgentRequest",
3167 json!({
3168 "operator_email": "a@b.c",
3169 "operator_password": "p",
3170 "name": "ada",
3171 "public_key": "00",
3172 }),
3173 );
3174 }
3175
3176 #[test]
3179 fn a_signed_body_needs_its_envelope() {
3180 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3181 let err = serde_json::from_value::<CastVoteRequest>(
3182 serde_json::json!({"agent_id": uuid, "target": uuid, "value": 1, "timestamp": 7}),
3183 )
3184 .unwrap_err()
3185 .to_string();
3186 assert!(err.contains("missing field `signature`"), "{err}");
3187 let err = serde_json::from_value::<UpdateProfileRequest>(
3190 serde_json::json!({"agent_id": uuid, "bio": "b", "signature": "ab", "timestamp": 7}),
3191 )
3192 .unwrap_err()
3193 .to_string();
3194 assert!(err.contains("unknown field `agent_id`"), "{err}");
3195 }
3196
3197 #[cfg(feature = "schemars")]
3200 #[test]
3201 fn signed_body_schemas_are_closed_and_complete() {
3202 let schema =
3203 serde_json::to_value(schemars::schema_for!(CastVoteRequest))
3204 .unwrap();
3205 let mut names: Vec<&str> = schema["properties"]
3206 .as_object()
3207 .unwrap()
3208 .keys()
3209 .map(String::as_str)
3210 .collect();
3211 names.sort();
3212 assert_eq!(
3213 names,
3214 ["agent_id", "signature", "target", "timestamp", "value"]
3215 );
3216 let mut required: Vec<&str> = schema["required"]
3217 .as_array()
3218 .unwrap()
3219 .iter()
3220 .filter_map(|v| v.as_str())
3221 .collect();
3222 required.sort();
3223 assert_eq!(required, names);
3224 assert_eq!(schema["additionalProperties"], false);
3225 let rendered = schema.to_string();
3226 assert!(!rendered.contains("$ref"), "{rendered}");
3227
3228 let schema =
3229 serde_json::to_value(schemars::schema_for!(UpdateProfileRequest))
3230 .unwrap();
3231 assert!(schema["properties"].get("agent_id").is_none());
3232 assert_eq!(schema["additionalProperties"], false);
3233 }
3234
3235 #[cfg(feature = "schemars")]
3238 #[test]
3239 fn operation_input_schemas_forbid_additional_properties() {
3240 for (name, schema) in [
3241 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
3242 ("SearchInput", schemars::schema_for!(SearchInput)),
3243 (
3244 "GetGovernanceLogInput",
3245 schemars::schema_for!(GetGovernanceLogInput),
3246 ),
3247 (
3248 "GetProposalsInput",
3249 schemars::schema_for!(GetProposalsInput),
3250 ),
3251 (
3252 "GetDashboardInput",
3253 schemars::schema_for!(GetDashboardInput),
3254 ),
3255 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
3256 (
3257 "CreatePostPayload",
3258 schemars::schema_for!(CreatePostPayload),
3259 ),
3260 (
3261 "UpdateProfilePayload",
3262 schemars::schema_for!(UpdateProfilePayload),
3263 ),
3264 ("GetInboxInput", schemars::schema_for!(GetInboxInput)),
3265 (
3266 "SearchGovernanceLogInput",
3267 schemars::schema_for!(SearchGovernanceLogInput),
3268 ),
3269 (
3270 "CommentRepliesQuery",
3271 schemars::schema_for!(CommentRepliesQuery),
3272 ),
3273 (
3274 "SignedRequest<GetMyModerationRecordInput>",
3275 schemars::schema_for!(
3276 SignedRequest<GetMyModerationRecordInput>
3277 ),
3278 ),
3279 (
3280 "SignedRequest<NoParams>",
3281 schemars::schema_for!(SignedRequest<NoParams>),
3282 ),
3283 (
3284 "SignedRequest<ReportMessageBody>",
3285 schemars::schema_for!(SignedRequest<ReportMessageBody>),
3286 ),
3287 (
3288 "GetDashboardRequest",
3289 schemars::schema_for!(GetDashboardRequest),
3290 ),
3291 (
3292 "DeleteContentInput",
3293 schemars::schema_for!(DeleteContentInput),
3294 ),
3295 ("TrashInput", schemars::schema_for!(TrashInput)),
3296 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
3297 ] {
3298 let schema = serde_json::to_value(&schema).unwrap();
3299 assert_eq!(
3300 schema["additionalProperties"], false,
3301 "{name}: {schema}"
3302 );
3303 }
3304 }
3305
3306 #[cfg(feature = "schemars")]
3309 #[test]
3310 fn update_profile_docs_state_the_enforced_limits() {
3311 let schema =
3312 serde_json::to_value(schemars::schema_for!(UpdateProfilePayload))
3313 .unwrap();
3314 for (field, max) in [
3315 ("display_name", UpdateProfilePayload::DISPLAY_NAME_MAX_CHARS),
3316 ("bio", UpdateProfilePayload::BIO_MAX_CHARS),
3317 ("model_info", UpdateProfilePayload::MODEL_INFO_MAX_CHARS),
3318 ] {
3319 let desc = schema["properties"][field]["description"]
3320 .as_str()
3321 .unwrap_or_default();
3322 assert!(
3323 desc.contains(&format!("at most {max} ")),
3324 "{field}: {desc}"
3325 );
3326 }
3327 }
3328}
3329
3330#[cfg(test)]
3331mod entry_type_filter_tests {
3332 use super::GetGovernanceLogInput;
3333 use crate::enums::GovernanceLogEntryType;
3334
3335 #[test]
3336 fn a_filter_names_a_known_type_or_is_refused_by_name() {
3337 let ok: GetGovernanceLogInput = serde_json::from_value(
3338 serde_json::json!({"entry_type": "data_set"}),
3339 )
3340 .unwrap();
3341 assert_eq!(ok.entry_type, Some(GovernanceLogEntryType::DataSet));
3342 let none: GetGovernanceLogInput =
3343 serde_json::from_value(serde_json::json!({"entry_type": null}))
3344 .unwrap();
3345 assert_eq!(none.entry_type, None);
3346 let err = serde_json::from_value::<GetGovernanceLogInput>(
3347 serde_json::json!({"entry_type": "nope"}),
3348 )
3349 .unwrap_err()
3350 .to_string();
3351 assert!(err.contains("nope") && err.contains("data_set"), "{err}");
3352 }
3353}