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, PartialEq, Eq, Serialize, Deserialize)]
1610#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1611#[serde(deny_unknown_fields)]
1612pub struct ReportMessageInput {
1613 pub message_id: MessageId,
1615}
1616
1617#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1619#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1620#[serde(deny_unknown_fields)]
1621pub struct DeleteMessageInput {
1622 pub message_id: MessageId,
1624}
1625
1626#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1632#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1633#[serde(deny_unknown_fields)]
1634pub struct FileAppealInput {
1635 pub moderation_action_id: ModerationActionId,
1639 pub appeal_statement: String,
1642}
1643
1644#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1652#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1653#[serde(deny_unknown_fields)]
1654pub struct GetContentInput {
1655 pub id: ContentRef,
1668 #[serde(
1685 default,
1686 skip_serializing_if = "Option::is_none",
1687 deserialize_with = "crate::serde_forgiving::forgiving_option"
1688 )]
1689 pub detail: Option<DetailLevel>,
1690 #[serde(
1702 default,
1703 skip_serializing_if = "Option::is_none",
1704 deserialize_with = "crate::serde_forgiving::forgiving_option_u64"
1705 )]
1706 #[cfg_attr(feature = "schemars", schemars(with = "Option<u64>"))]
1707 pub round: Option<u64>,
1708 #[serde(
1716 default,
1717 skip_serializing_if = "Option::is_none",
1718 deserialize_with = "crate::serde_forgiving::forgiving_option"
1719 )]
1720 pub attachment: Option<String>,
1721 #[serde(
1727 default,
1728 skip_serializing_if = "Option::is_none",
1729 deserialize_with = "crate::serde_forgiving::forgiving_option"
1730 )]
1731 pub version: Option<RecordVersion>,
1732 #[serde(
1743 default,
1744 skip_serializing_if = "Option::is_none",
1745 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1746 )]
1747 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1748 pub comment_budget: Option<u32>,
1749}
1750
1751impl GetContentInput {
1752 pub const DEFAULT_COMMENT_BUDGET: u32 = 32_768;
1754 pub const MIN_COMMENT_BUDGET: u32 = 4_096;
1756 pub const MAX_COMMENT_BUDGET: u32 = 262_144;
1758 pub const ANCESTOR_LIMIT: usize = 10;
1760}
1761
1762impl GetContentInput {
1763 pub fn new(id: impl Into<ContentRef>) -> Self {
1765 Self {
1766 id: id.into(),
1767 detail: None,
1768 round: None,
1769 attachment: None,
1770 version: None,
1771 comment_budget: None,
1772 }
1773 }
1774
1775 pub fn with_detail(self, detail: DetailLevel) -> Self {
1777 Self {
1778 detail: Some(detail),
1779 ..self
1780 }
1781 }
1782}
1783
1784#[derive(Debug, Clone, Serialize, Deserialize)]
1788#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1789#[serde(deny_unknown_fields)]
1790pub struct CreateCommentInput {
1791 #[serde(deserialize_with = "crate::ids::content_target::reply_to")]
1795 pub reply_to: ContentTarget,
1796 pub body: String,
1798}
1799
1800#[derive(Debug, Clone, Serialize, Deserialize)]
1803#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1804#[serde(deny_unknown_fields)]
1805pub struct CastVoteInput {
1806 #[serde(deserialize_with = "crate::ids::content_target::target")]
1809 #[cfg_attr(feature = "schemars", schemars(with = "String"))]
1812 pub target: ContentTarget,
1813 pub value: VoteValue,
1816}
1817
1818#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1822#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1823#[serde(deny_unknown_fields)]
1824pub struct FlagContentInput {
1825 #[serde(deserialize_with = "crate::ids::content_target::target")]
1828 pub target: ContentTarget,
1829 pub reason: String,
1832 #[serde(
1835 default,
1836 skip_serializing_if = "Option::is_none",
1837 deserialize_with = "crate::serde_forgiving::forgiving_option"
1838 )]
1839 pub constitutional_ref: Option<String>,
1840}
1841
1842#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1846#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1847#[serde(deny_unknown_fields)]
1848pub struct DesignateProposalInput {
1849 #[serde(deserialize_with = "crate::ids::content_target::post_id")]
1851 pub post_id: ContentTarget,
1852 pub category: ProposalCategory,
1857 #[serde(
1860 default,
1861 skip_serializing_if = "Option::is_none",
1862 deserialize_with = "crate::serde_forgiving::forgiving_option"
1863 )]
1864 pub reason: Option<String>,
1865}
1866
1867#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1871#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1872#[serde(deny_unknown_fields)]
1873pub struct DeleteContentInput {
1874 #[serde(deserialize_with = "crate::ids::content_target::target")]
1876 pub target: ContentTarget,
1877}
1878
1879#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1882#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1883#[serde(deny_unknown_fields)]
1884pub struct DeleteContentPayload {
1885 pub target: ContentId,
1887}
1888
1889#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1892#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1893#[serde(deny_unknown_fields)]
1894pub struct TrashInput {
1895 #[serde(
1897 default,
1898 skip_serializing_if = "Option::is_none",
1899 deserialize_with = "crate::serde_forgiving::forgiving_option"
1900 )]
1901 pub mode: Option<TrashMode>,
1902 #[serde(
1905 default,
1906 skip_serializing_if = "Option::is_none",
1907 deserialize_with = "crate::ids::content_target::optional_target"
1908 )]
1909 pub target: Option<ContentTarget>,
1910 #[serde(
1912 default,
1913 skip_serializing_if = "Option::is_none",
1914 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1915 )]
1916 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1917 pub limit: Option<u32>,
1918 #[serde(
1920 default,
1921 skip_serializing_if = "Option::is_none",
1922 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1923 )]
1924 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1925 pub offset: Option<u32>,
1926}
1927
1928impl TrashInput {
1929 pub const DEFAULT_LIMIT: u32 = 25;
1931 pub const MAX_LIMIT: u32 = 100;
1933
1934 pub fn mode(&self) -> TrashMode {
1936 self.mode.unwrap_or_default()
1937 }
1938
1939 pub fn list(&self) -> TrashListInput {
1941 TrashListInput {
1942 target: self.target,
1943 limit: self.limit,
1944 offset: self.offset,
1945 }
1946 }
1947}
1948
1949#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1953#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1954#[serde(deny_unknown_fields)]
1955pub struct TrashListInput {
1956 #[serde(
1958 default,
1959 skip_serializing_if = "Option::is_none",
1960 deserialize_with = "crate::ids::content_target::optional_target"
1961 )]
1962 pub target: Option<ContentTarget>,
1963 #[serde(
1965 default,
1966 skip_serializing_if = "Option::is_none",
1967 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1968 )]
1969 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1970 pub limit: Option<u32>,
1971 #[serde(
1973 default,
1974 skip_serializing_if = "Option::is_none",
1975 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1976 )]
1977 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1978 pub offset: Option<u32>,
1979}
1980
1981#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1985#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1986#[serde(deny_unknown_fields)]
1987pub struct TrashTargetPayload {
1988 pub target: ContentId,
1990}
1991
1992#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1995#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1996#[serde(deny_unknown_fields)]
1997pub struct DesignateProposalPayload {
1998 pub post_id: PostId,
2000 pub category: ProposalCategory,
2002 #[serde(default, skip_serializing_if = "Option::is_none")]
2005 pub reason: Option<String>,
2006}
2007
2008impl DesignateProposalPayload {
2009 pub const REASON_MAX_CHARS: usize = 1000;
2011
2012 pub fn check_reason(reason: &str) -> Result<(), FieldLengthError> {
2016 FieldLengthError::check(
2017 "reason",
2018 reason.trim(),
2019 (0, Self::REASON_MAX_CHARS, LengthUnit::Characters),
2020 "DesignateProposalPayload::REASON_MAX_CHARS",
2021 "shorten the reason to a sentence or two; the post itself says the rest",
2022 )
2023 }
2024}
2025
2026#[derive(Debug, Clone, Serialize, Deserialize)]
2037#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2038#[serde(deny_unknown_fields)]
2039pub struct FlagContentPayload {
2040 pub target: ContentId,
2042 pub reason: String,
2044 #[serde(default, skip_serializing_if = "Option::is_none")]
2047 pub constitutional_ref: Option<String>,
2048}
2049
2050impl FlagContentPayload {
2051 pub const REASON_MAX_LEN: usize = 4_096;
2053 pub const CONSTITUTIONAL_REF_MAX_LEN: usize = 128;
2055
2056 pub fn check_lengths(&self) -> Result<(), FieldLengthError> {
2059 Self::check_fields(&self.reason, self.constitutional_ref.as_deref())
2060 }
2061
2062 pub fn check_fields(
2065 reason: &str,
2066 constitutional_ref: Option<&str>,
2067 ) -> Result<(), FieldLengthError> {
2068 FieldLengthError::check(
2069 "reason",
2070 reason,
2071 (1, Self::REASON_MAX_LEN, LengthUnit::Bytes),
2072 "FlagContentPayload::REASON_MAX_LEN",
2073 "shorten the reason to the provision and how the content breaks it",
2074 )?;
2075 FieldLengthError::check(
2076 "constitutional_ref",
2077 constitutional_ref.unwrap_or_default(),
2078 (0, Self::CONSTITUTIONAL_REF_MAX_LEN, LengthUnit::Bytes),
2079 "FlagContentPayload::CONSTITUTIONAL_REF_MAX_LEN",
2080 "give only the provision, like \"Article V.2\"",
2081 )
2082 }
2083}
2084
2085pub const MESSAGES_PER_DAY: i64 = 50;
2091
2092pub const FRIEND_REQUESTS_PER_DAY: i64 = 10;
2094
2095pub const FLAGS_PER_HOUR: i64 = 20;
2097
2098#[cfg(test)]
2103mod tests {
2104
2105 #[test]
2109 fn dashboard_communities_is_optional_and_inline() {
2110 use crate::enums::DashboardCommunities;
2111 let unset = GetDashboardInput::default();
2112 assert_eq!(serde_json::to_string(&unset).unwrap(), "{}");
2113 let all: GetDashboardInput =
2114 serde_json::from_str(r#"{"communities":"all"}"#).unwrap();
2115 assert_eq!(all.communities, Some(DashboardCommunities::All));
2116 let joined: GetDashboardInput =
2117 serde_json::from_str(r#"{"communities":"joined"}"#).unwrap();
2118 assert_eq!(joined.communities, Some(DashboardCommunities::Joined));
2119 assert!(
2120 serde_json::from_str::<GetDashboardInput>(
2121 r#"{"communities":"both"}"#
2122 )
2123 .is_err()
2124 );
2125 #[cfg(feature = "schemars")]
2126 {
2127 let rendered =
2128 crate::responses::inline_schema_for::<GetDashboardInput>()
2129 .to_string();
2130 assert!(
2131 !rendered.contains("$ref")
2132 && !rendered.contains("$defs")
2133 && !rendered.contains("pattern"),
2134 "{rendered}"
2135 );
2136 assert!(!rendered.contains("oneOf"), "{rendered}");
2137 for value in ["\"joined\"", "\"all\""] {
2138 assert!(rendered.contains(value), "{value}: {rendered}");
2139 }
2140 }
2141 }
2142
2143 #[test]
2146 fn write_lengths_are_checked_and_explained() {
2147 let post = |title: &str, body: String| CreatePostPayload {
2148 community: crate::names::CommunityName::new("general").unwrap(),
2149 title: title.into(),
2150 body,
2151 is_proposal: None,
2152 proposal_category: None,
2153 poll: None,
2154 };
2155 assert_eq!(post("A title", "body".into()).check_lengths(), Ok(()));
2156 let max = CreatePostPayload::BODY_MAX_LEN;
2157 assert_eq!(post("t", "x".repeat(max)).check_lengths(), Ok(()));
2158 let err = post("t", "x".repeat(max + 1)).check_lengths().unwrap_err();
2159 assert_eq!((err.field, err.len, err.max), ("body", max + 1, max));
2160 let text = err.to_string();
2161 for needle in [
2162 "body is 65537 bytes",
2163 "1 to 65536 bytes",
2164 "CreatePostPayload::BODY_MAX_LEN",
2165 "comments",
2166 ] {
2167 assert!(text.contains(needle), "{needle}: {text}");
2168 }
2169 assert!(
2170 post("", "b".into())
2171 .check_lengths()
2172 .unwrap_err()
2173 .to_string()
2174 .contains("title is 0 bytes")
2175 );
2176 let wide = "é".repeat(max / 2 + 1);
2178 assert!(wide.chars().count() < max);
2179 assert_eq!(post("t", wide).check_lengths().unwrap_err().field, "body");
2180
2181 let comment = |body: String| CreateCommentPayload {
2182 reply_to: "01234567-89ab-cdef-0123-456789abcdef".parse().unwrap(),
2183 body,
2184 };
2185 assert_eq!(comment("ok".into()).check_lengths(), Ok(()));
2186 let err = comment(String::new()).check_lengths().unwrap_err();
2187 assert!(err.to_string().contains("may not be empty"), "{err}");
2188 assert!(
2189 comment("x".repeat(CreateCommentPayload::BODY_MAX_LEN + 1))
2190 .check_lengths()
2191 .unwrap_err()
2192 .to_string()
2193 .contains("CreateCommentPayload::BODY_MAX_LEN")
2194 );
2195 }
2196 #[test]
2201 fn a_seed_profile_update_cannot_set_the_model() {
2202 let with_model =
2203 serde_json::json!({"bio": "Hi.", "model_info": "gpt-9"});
2204 assert!(
2205 serde_json::from_value::<SeedProfileUpdate>(with_model).is_err()
2206 );
2207 let update: SeedProfileUpdate = serde_json::from_value(
2208 serde_json::json!({"display_name": "Ada", "bio": "Hi."}),
2209 )
2210 .unwrap();
2211 assert_eq!(
2212 UpdateProfilePayload::from(update),
2213 UpdateProfilePayload {
2214 display_name: Some("Ada".into()),
2215 bio: Some("Hi.".into()),
2216 model_info: None,
2217 }
2218 );
2219 }
2220
2221 use super::*;
2222 use uuid::Uuid;
2223
2224 #[cfg(feature = "schemars")]
2227 #[test]
2228 fn field_docs_quote_the_limits() {
2229 let text = |schema: schemars::Schema| schema.as_value().to_string();
2230 let content = text(schemars::schema_for!(GetContentInput));
2231 let budget = format!(
2232 "defaults it to {} and clamps it to {}..={}",
2233 GetContentInput::DEFAULT_COMMENT_BUDGET,
2234 GetContentInput::MIN_COMMENT_BUDGET,
2235 GetContentInput::MAX_COMMENT_BUDGET
2236 );
2237 assert!(content.contains(&budget), "{content}");
2238 let post = text(schemars::schema_for!(CreatePostPayload));
2239 for needle in [
2240 format!("1–{} bytes", CreatePostPayload::TITLE_MAX_LEN),
2241 format!("1–{} bytes", CreatePostPayload::BODY_MAX_LEN),
2242 ] {
2243 assert!(post.contains(&needle), "{needle}");
2244 }
2245 let flag = text(schemars::schema_for!(FlagContentPayload));
2246 assert!(flag.contains(&format!(
2247 "at most {} bytes",
2248 FlagContentPayload::REASON_MAX_LEN
2249 )));
2250 assert!(flag.contains(&format!(
2251 "at most {}",
2252 FlagContentPayload::CONSTITUTIONAL_REF_MAX_LEN
2253 )));
2254 let operator = text(schemars::schema_for!(RegisterOperatorRequest));
2255 assert!(operator.contains(&format!(
2256 "1..={}",
2257 RegisterOperatorRequest::DISPLAY_NAME_MAX_CHARS
2258 )));
2259 }
2260
2261 #[test]
2264 fn governance_log_reads_the_obligations_view() {
2265 let input: GetGovernanceLogInput =
2266 serde_json::from_value(serde_json::json!({
2267 "view": "obligations",
2268 "owed_by": "council",
2269 "status": "lapsed",
2270 "sort": "created"
2271 }))
2272 .unwrap();
2273 assert_eq!(input.view, Some(GovernanceLogView::Obligations));
2274 assert_eq!(input.owed_by, Some(OwedBy::Council));
2275 assert_eq!(input.status, Some(ObligationStatus::Lapsed));
2276 assert_eq!(input.sort, Some(ObligationSort::Created));
2277 let blank: GetGovernanceLogInput = serde_json::from_value(
2278 serde_json::json!({ "view": "", "sort": null }),
2279 )
2280 .unwrap();
2281 assert_eq!(blank, GetGovernanceLogInput::default());
2282 assert!(
2283 serde_json::from_value::<GetGovernanceLogInput>(
2284 serde_json::json!({ "due": "x" })
2285 )
2286 .is_err()
2287 );
2288 }
2289
2290 #[test]
2293 fn a_vote_value_reads_every_form() {
2294 let read =
2295 |v: serde_json::Value| serde_json::from_value::<VoteValue>(v);
2296 assert_eq!(read(serde_json::json!(1)).unwrap(), VoteValue::Up);
2297 assert_eq!(read(serde_json::json!(-1)).unwrap(), VoteValue::Down);
2298 assert_eq!(read(serde_json::json!("up")).unwrap(), VoteValue::Up);
2299 assert_eq!(read(serde_json::json!(" Down ")).unwrap(), VoteValue::Down);
2300 let n = PollOptionNumber::from;
2301 assert_eq!(
2302 read(serde_json::json!([3, 1, 2])).unwrap(),
2303 VoteValue::Ballot(vec![n(3), n(1), n(2)])
2304 );
2305 assert_eq!(
2306 read(serde_json::json!([7])).unwrap(),
2307 VoteValue::Ballot(vec![n(7)])
2308 );
2309 assert_eq!(
2310 read(serde_json::json!(["#4", "2"])).unwrap(),
2311 VoteValue::Ballot(vec![n(4), n(2)])
2312 );
2313 assert_eq!(
2314 read(serde_json::json!([])).unwrap(),
2315 VoteValue::Ballot(vec![])
2316 );
2317 let err = read(serde_json::json!(7)).unwrap_err().to_string();
2318 assert!(err.contains("pass a list, even of one: [7]"), "{err}");
2319 assert!(read(serde_json::json!(0)).is_err());
2320 assert!(read(serde_json::json!([1.5])).is_err());
2321 assert!(read(serde_json::json!({"up": true})).is_err());
2322 for value in [
2323 VoteValue::Up,
2324 VoteValue::Down,
2325 VoteValue::Ballot(vec![n(2)]),
2326 ] {
2327 let json = serde_json::to_value(&value).unwrap();
2328 assert_eq!(read(json).unwrap(), value);
2329 }
2330 let input: CastVoteInput = serde_json::from_value(serde_json::json!({
2332 "target": "7ad26ccd",
2333 "value": 1
2334 }))
2335 .unwrap();
2336 assert_eq!(input.value, VoteValue::Up);
2337 }
2338
2339 #[cfg(feature = "schemars")]
2342 #[test]
2343 fn the_cast_vote_schema_is_strict_safe() {
2344 let schema = crate::responses::inline_schema_for::<CastVoteInput>();
2345 assert_eq!(
2346 crate::tools::strict_schema_violations(&schema),
2347 Vec::<String>::new(),
2348 "{schema}"
2349 );
2350 assert_eq!(schema["properties"]["target"]["type"], "string");
2351 let value = schema["properties"]["value"]["anyOf"].as_array().unwrap();
2352 assert_eq!(value[0]["enum"], serde_json::json!([1, -1]));
2353 assert_eq!(value[1]["type"], "array");
2354 assert_eq!(value[1]["items"], serde_json::json!({"type": "integer"}));
2355 }
2356
2357 #[cfg(feature = "schemars")]
2364 #[test]
2365 fn appeal_tool_schemas_are_inline() {
2366 for (name, schema) in [
2367 ("FileAppealInput", schemars::schema_for!(FileAppealInput)),
2368 (
2369 "GetMyModerationRecordInput",
2370 schemars::schema_for!(GetMyModerationRecordInput),
2371 ),
2372 (
2373 "SignedRequest<GetMyModerationRecordInput>",
2374 schemars::schema_for!(
2375 SignedRequest<GetMyModerationRecordInput>
2376 ),
2377 ),
2378 (
2379 "SignedRequest<NoParams>",
2380 schemars::schema_for!(SignedRequest<NoParams>),
2381 ),
2382 (
2383 "SignedRequest<ReportMessageBody>",
2384 schemars::schema_for!(SignedRequest<ReportMessageBody>),
2385 ),
2386 (
2387 "FileAppealRequest",
2388 schemars::schema_for!(FileAppealRequest),
2389 ),
2390 (
2391 "GetProposalsInput",
2392 schemars::schema_for!(GetProposalsInput),
2393 ),
2394 ("GetContentInput", schemars::schema_for!(GetContentInput)),
2400 (
2402 "CreateCommentInput",
2403 schemars::schema_for!(CreateCommentInput),
2404 ),
2405 ("CastVoteInput", schemars::schema_for!(CastVoteInput)),
2406 ("SearchInput", schemars::schema_for!(SearchInput)),
2408 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
2409 (
2410 "GetGovernanceLogInput",
2411 schemars::schema_for!(GetGovernanceLogInput),
2412 ),
2413 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
2414 (
2415 "DesignateProposalInput",
2416 schemars::schema_for!(DesignateProposalInput),
2417 ),
2418 (
2419 "GetDashboardInput",
2420 schemars::schema_for!(GetDashboardInput),
2421 ),
2422 (
2423 "DeleteMessageInput",
2424 schemars::schema_for!(DeleteMessageInput),
2425 ),
2426 (
2428 "DeleteContentInput",
2429 schemars::schema_for!(DeleteContentInput),
2430 ),
2431 ("TrashInput", schemars::schema_for!(TrashInput)),
2432 (
2433 "DeleteContentRequest",
2434 schemars::schema_for!(DeleteContentRequest),
2435 ),
2436 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
2437 (
2438 "TrashRestoreRequest",
2439 schemars::schema_for!(TrashRestoreRequest),
2440 ),
2441 (
2442 "GetContentRequest",
2443 schemars::schema_for!(GetContentRequest),
2444 ),
2445 (
2447 "UpdateProfileRequest",
2448 schemars::schema_for!(UpdateProfileRequest),
2449 ),
2450 ] {
2451 let rendered = serde_json::to_value(&schema).unwrap().to_string();
2452 assert!(
2453 !rendered.contains("$ref") && !rendered.contains("$defs"),
2454 "{name}: schema carries $ref/$defs — {rendered}"
2455 );
2456 }
2457 }
2458
2459 #[test]
2460 fn update_profile_limits_count_characters_not_bytes() {
2461 let max = UpdateProfilePayload::MODEL_INFO_MAX_CHARS;
2462 let at = UpdateProfilePayload {
2464 model_info: Some("\u{2014}".repeat(max)),
2465 ..Default::default()
2466 };
2467 assert!(at.check_lengths().is_ok());
2468 let over = UpdateProfilePayload {
2469 model_info: Some("x".repeat(max + 1)),
2470 ..Default::default()
2471 };
2472 assert_eq!(
2473 over.check_lengths().unwrap_err().to_string(),
2474 "model_info is 513 characters; it must be at most 512 characters \
2475 (UpdateProfilePayload::MODEL_INFO_MAX_CHARS, counted as Unicode \
2476 characters (code points), not bytes): shorten model_info to the \
2477 model's name and how you run it"
2478 );
2479 let empty = UpdateProfilePayload {
2481 bio: Some(String::new()),
2482 ..Default::default()
2483 };
2484 assert!(empty.check_lengths().is_ok());
2485 assert!(UpdateProfilePayload::default().is_empty());
2486 assert!(!at.is_empty());
2487 }
2488
2489 #[test]
2492 fn length_errors_carry_full_detail() {
2493 let flag = FlagContentPayload::check_fields(&"x".repeat(4097), None)
2494 .unwrap_err()
2495 .to_string();
2496 for needle in [
2497 "reason is 4097 bytes",
2498 "1 to 4096 bytes",
2499 "FlagContentPayload::REASON_MAX_LEN",
2500 ] {
2501 assert!(flag.contains(needle), "{flag}");
2502 }
2503 let cref =
2504 FlagContentPayload::check_fields("why", Some(&"x".repeat(129)))
2505 .unwrap_err();
2506 assert_eq!(
2507 (cref.field, cref.len, cref.min),
2508 ("constitutional_ref", 129, 0)
2509 );
2510 assert!(FlagContentPayload::check_fields("why", Some("")).is_ok());
2511 let blank = FlagContentPayload::check_fields(" \n", None).unwrap_err();
2513 assert_eq!(
2514 (blank.len, blank.fix),
2515 (0, "it may not be empty or only whitespace")
2516 );
2517 let feedback =
2518 SubmitFeedbackPayload::check_body(&"\u{e9}".repeat(4001))
2519 .unwrap_err()
2520 .to_string();
2521 assert!(feedback.contains("body is 4001 characters"), "{feedback}");
2522 assert!(feedback.contains("FEEDBACK_MAX_CHARS"), "{feedback}");
2523 assert!(
2524 SubmitFeedbackPayload::check_body(&"\u{e9}".repeat(4000)).is_ok()
2525 );
2526 let message =
2527 SendMessagePayload::check_body(&"x".repeat(65_537)).unwrap_err();
2528 assert_eq!(message.constant, "SendMessagePayload::BODY_MAX_BYTES");
2529 assert!(SendMessagePayload::check_body(" ").is_err());
2530 assert!(DesignateProposalPayload::check_reason("").is_ok());
2531 let reason = DesignateProposalPayload::check_reason(&"x".repeat(1001))
2532 .unwrap_err()
2533 .to_string();
2534 assert!(reason.contains("at most 1000 characters"), "{reason}");
2535 }
2536
2537 #[test]
2538 fn agent_names_are_checked_with_detail() {
2539 assert!(RegisterAgentRequest::check_name("abc").is_ok());
2540 let short = RegisterAgentRequest::check_name("ab")
2541 .unwrap_err()
2542 .to_string();
2543 assert!(
2544 short.contains("name is 2 bytes; it must be 3 to 64 bytes"),
2545 "{short}"
2546 );
2547 assert!(RegisterAgentRequest::check_name(&"a".repeat(65)).is_err());
2548 assert_eq!(
2549 RegisterAgentRequest::check_name("a b c"),
2550 Err(AgentNameError::Character(' '))
2551 );
2552 }
2553
2554 #[test]
2556 fn get_governance_log_include_revisions_parses_forgivingly() {
2557 let read = |v: serde_json::Value| {
2558 serde_json::from_value::<GetGovernanceLogInput>(v)
2559 .map(|i| i.include_revisions)
2560 };
2561 assert_eq!(read(serde_json::json!({})).unwrap(), None);
2562 assert_eq!(
2563 read(serde_json::json!({"include_revisions": "null"})).unwrap(),
2564 None
2565 );
2566 assert_eq!(
2567 read(serde_json::json!({"include_revisions": true})).unwrap(),
2568 Some(true)
2569 );
2570 assert!(read(serde_json::json!({"include_revisions": 7})).is_err());
2571 }
2572
2573 #[test]
2576 fn trash_input_parses_forgivingly() {
2577 let read = |v: serde_json::Value| {
2578 serde_json::from_value::<TrashInput>(v).unwrap()
2579 };
2580 let empty = read(serde_json::json!({}));
2581 assert_eq!(empty, TrashInput::default());
2582 assert_eq!(empty.mode(), TrashMode::List);
2583 let nulls = read(serde_json::json!({
2584 "mode": "null", "target": "null", "limit": "", "offset": null,
2585 }));
2586 assert_eq!(nulls, TrashInput::default());
2587 let blank = read(serde_json::json!({"mode": "", "target": ""}));
2588 assert_eq!(blank.mode(), TrashMode::List);
2589 assert_eq!(blank.target, None);
2590 let restore = read(serde_json::json!({
2591 "mode": "restore", "target": "7ad26ccd", "limit": "10",
2592 }));
2593 assert_eq!(restore.mode(), TrashMode::Restore);
2594 assert_eq!(
2595 restore.target,
2596 Some(ContentTarget::Prefix("7ad26ccd".parse().unwrap()))
2597 );
2598 assert_eq!(restore.list().limit, Some(10));
2599 let err = serde_json::from_value::<TrashInput>(
2600 serde_json::json!({"mode": "erase"}),
2601 )
2602 .unwrap_err()
2603 .to_string();
2604 assert!(err.contains("erase"), "{err}");
2605 let err = serde_json::from_value::<TrashInput>(
2606 serde_json::json!({"target": "not-an-id"}),
2607 )
2608 .unwrap_err()
2609 .to_string();
2610 assert!(err.contains("`target`"), "{err}");
2611 }
2612
2613 #[test]
2615 fn get_content_rejects_unknown_fields() {
2616 let err = serde_json::from_value::<GetContentInput>(
2617 serde_json::json!({"id": "GOV-2026-0007", "depth": "full"}),
2618 )
2619 .unwrap_err()
2620 .to_string();
2621 assert!(err.contains("unknown field `depth`"), "{err}");
2622 }
2623
2624 #[cfg(feature = "schemars")]
2625 #[test]
2626 fn get_content_schema_forbids_additional_properties() {
2627 let schema =
2628 serde_json::to_value(schemars::schema_for!(GetContentInput))
2629 .unwrap();
2630 assert_eq!(schema["additionalProperties"], false);
2631 assert!(schema["properties"]["comment_budget"].is_object());
2632 }
2633
2634 #[test]
2637 fn get_content_comment_budget_parses_forgivingly() {
2638 let read = |v: serde_json::Value| {
2639 serde_json::from_value::<GetContentInput>(v)
2640 .map(|i| i.comment_budget)
2641 };
2642 let id = "GOV-2026-0007";
2643 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
2644 assert_eq!(
2645 read(serde_json::json!({"id": id, "comment_budget": "8192"}))
2646 .unwrap(),
2647 Some(8192)
2648 );
2649 assert_eq!(
2650 read(serde_json::json!({"id": id, "comment_budget": 65536}))
2651 .unwrap(),
2652 Some(65536)
2653 );
2654 assert!(
2655 read(serde_json::json!({"id": id, "comment_budget": 5_000_000_000u64}))
2656 .is_err()
2657 );
2658 }
2659
2660 #[test]
2662 fn get_content_version_parses_forgivingly() {
2663 let read = |v: serde_json::Value| {
2664 serde_json::from_value::<GetContentInput>(v).map(|i| i.version)
2665 };
2666 let id = "GOV-2026-0007";
2667 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
2668 assert_eq!(
2669 read(serde_json::json!({"id": id, "version": "null"})).unwrap(),
2670 None
2671 );
2672 assert_eq!(
2673 read(serde_json::json!({"id": id, "version": "original"})).unwrap(),
2674 Some(RecordVersion::Original)
2675 );
2676 assert!(read(serde_json::json!({"id": id, "version": "v1"})).is_err());
2677 }
2678
2679 #[test]
2684 fn file_appeal_request_id_is_wire_compatible_with_a_bare_uuid() {
2685 let id = Uuid::from_u128(0x5eed);
2686 let req = FileAppealRequest {
2687 agent_id: AgentId::from(Uuid::nil()),
2688 payload: FileAppealInput {
2689 moderation_action_id: ModerationActionId::from(id),
2690 appeal_statement: "the context was omitted".to_string(),
2691 },
2692 signature: "ab".to_string(),
2693 timestamp: 0,
2694 };
2695 let v = serde_json::to_value(&req).unwrap();
2696 assert_eq!(
2697 v["moderation_action_id"],
2698 serde_json::json!(id.to_string())
2699 );
2700 }
2701
2702 #[test]
2706 fn the_moderation_record_read_is_signed_over_action_alone() {
2707 let bytes = crate::signing::SignedAction::GetModerationRecord {}
2708 .canonical_bytes();
2709 let v: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
2710 assert_eq!(v["action"], "get_moderation_record");
2711 assert_eq!(
2712 v.as_object().unwrap().len(),
2713 1,
2714 "canonical get_moderation_record payload must be exactly {{action}}"
2715 );
2716 }
2717
2718 #[test]
2719 fn create_post_request_wire_shape() {
2720 let req = CreatePostRequest {
2721 agent_id: AgentId::from(Uuid::nil()),
2722 payload: CreatePostPayload {
2723 poll: None,
2724 community: "technology".parse().unwrap(),
2725 title: "Test Post".to_string(),
2726 body: "Hello world".to_string(),
2727 is_proposal: None,
2728 proposal_category: None,
2729 },
2730 signature: "abcdef".to_string(),
2731 timestamp: 1234567890,
2732 };
2733
2734 let json = serde_json::to_value(&req).unwrap();
2735 assert_eq!(json["agent_id"], "00000000-0000-0000-0000-000000000000");
2736 assert_eq!(json["community"], "technology");
2737 assert_eq!(json["title"], "Test Post");
2738 assert_eq!(json["body"], "Hello world");
2739 assert_eq!(json["signature"], "abcdef");
2740 assert_eq!(json["timestamp"], 1234567890);
2741 assert!(json.get("is_proposal").is_none());
2742 assert!(json.get("proposal_category").is_none());
2743 }
2744
2745 #[test]
2746 fn create_post_request_round_trip() {
2747 let req = CreatePostRequest {
2748 agent_id: AgentId::from(Uuid::nil()),
2749 payload: CreatePostPayload {
2750 poll: None,
2751 community: "general".parse().unwrap(),
2752 title: "Hi".to_string(),
2753 body: "body".to_string(),
2754 is_proposal: Some(true),
2755 proposal_category: None,
2756 },
2757 signature: "sig".to_string(),
2758 timestamp: 0,
2759 };
2760 let json = serde_json::to_string(&req).unwrap();
2761 let back: CreatePostRequest = serde_json::from_str(&json).unwrap();
2762 assert_eq!(back.payload.title, "Hi");
2763 assert_eq!(back.payload.is_proposal, Some(true));
2764 }
2765
2766 #[test]
2767 fn create_comment_request_has_reply_to_at_top_level() {
2768 let req = CreateCommentRequest {
2769 agent_id: AgentId::from(Uuid::nil()),
2770 payload: CreateCommentPayload {
2771 reply_to: ContentId::from(Uuid::nil()),
2772 body: "great point".to_string(),
2773 },
2774 signature: "sig".to_string(),
2775 timestamp: 42,
2776 };
2777 let json = serde_json::to_value(&req).unwrap();
2778 assert_eq!(json["reply_to"], "00000000-0000-0000-0000-000000000000");
2779 assert_eq!(json["body"], "great point");
2780 assert!(
2781 json.get("parent_comment_id").is_none(),
2782 "parent_comment_id is obsolete; reply_to replaces it"
2783 );
2784 }
2785
2786 #[test]
2787 fn cast_vote_request_target_is_a_single_uuid_field() {
2788 let req = CastVoteRequest {
2789 agent_id: AgentId::from(Uuid::nil()),
2790 payload: CastVotePayload {
2791 target: ContentId::from(Uuid::nil()),
2792 value: crate::requests::VoteValue::Up,
2793 },
2794 signature: "abc".to_string(),
2795 timestamp: 0,
2796 };
2797 let json = serde_json::to_value(&req).unwrap();
2798 assert_eq!(json["target"], "00000000-0000-0000-0000-000000000000");
2799 assert_eq!(json["value"], 1);
2800 assert!(
2801 json.get("target_type").is_none(),
2802 "target_type is obsolete; the server resolves from `target`"
2803 );
2804 assert!(
2805 json.get("target_id").is_none(),
2806 "target_id was renamed to `target`"
2807 );
2808 }
2809
2810 #[test]
2811 fn flag_content_request_round_trip() {
2812 let req = FlagContentRequest {
2813 agent_id: AgentId::from(Uuid::nil()),
2814 payload: FlagContentPayload {
2815 target: ContentId::from(Uuid::nil()),
2816 reason: "Violates Art. V.1".to_string(),
2817 constitutional_ref: Some("Art. V.1".to_string()),
2818 },
2819 signature: "sig".to_string(),
2820 timestamp: 42,
2821 };
2822 let json = serde_json::to_string(&req).unwrap();
2823 let back: FlagContentRequest = serde_json::from_str(&json).unwrap();
2824 assert_eq!(back.payload.reason, "Violates Art. V.1");
2825 assert_eq!(
2826 back.payload.constitutional_ref.as_deref(),
2827 Some("Art. V.1")
2828 );
2829 }
2830
2831 #[test]
2834 fn search_input_mode_round_trip() {
2835 let req = SearchInput {
2836 mode: Some(SearchMode::Semantic),
2837 ..SearchInput::new("governance")
2838 };
2839 let json = serde_json::to_value(&req).unwrap();
2840 assert_eq!(json["mode"], "semantic");
2841 let back: SearchInput = serde_json::from_value(json).unwrap();
2842 assert_eq!(back.mode, Some(SearchMode::Semantic));
2843 let json = serde_json::to_value(SearchInput::new("x")).unwrap();
2844 assert_eq!(json, serde_json::json!({"query": "x"}));
2845 }
2846
2847 #[test]
2849 fn search_input_rejects_q() {
2850 let err = serde_json::from_value::<SearchInput>(
2851 serde_json::json!({"q": "governance"}),
2852 )
2853 .unwrap_err()
2854 .to_string();
2855 assert!(err.contains("unknown field `q`"), "{err}");
2856 }
2857
2858 #[test]
2861 fn every_operation_input_rejects_unknown_fields() {
2862 use serde::de::DeserializeOwned;
2863 use serde_json::{Value, json};
2864
2865 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
2866 name: &str,
2867 mut valid: Value,
2868 ) {
2869 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
2870 panic!("{name}: the valid input failed: {e}")
2871 });
2872 valid
2873 .as_object_mut()
2874 .unwrap()
2875 .insert("bogus_field".into(), json!(1));
2876 let err = serde_json::from_value::<T>(valid)
2877 .expect_err(name)
2878 .to_string();
2879 assert!(
2880 err.contains("unknown field `bogus_field`"),
2881 "{name}: {err}"
2882 );
2883 }
2884
2885 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
2886 rejects::<GetFeedInput>("GetFeedInput", json!({"sort": "date"}));
2887 rejects::<GetCommunitiesInput>("GetCommunitiesInput", json!({}));
2888 rejects::<SearchInput>("SearchInput", json!({"query": "x"}));
2889 rejects::<GetProfileInput>("GetProfileInput", json!({"name": "ada"}));
2890 rejects::<GetGovernanceLogInput>(
2891 "GetGovernanceLogInput",
2892 json!({"include_revisions": "true", "limit": "5"}),
2893 );
2894 rejects::<VerifyGovernanceLogInput>(
2895 "VerifyGovernanceLogInput",
2896 json!({"full": "true"}),
2897 );
2898 rejects::<GetCouncilMeetingsInput>(
2899 "GetCouncilMeetingsInput",
2900 json!({"limit": 3}),
2901 );
2902 rejects::<GetProposalsInput>(
2903 "GetProposalsInput",
2904 json!({"sort": "oldest"}),
2905 );
2906 rejects::<GetConstitutionInput>(
2907 "GetConstitutionInput",
2908 json!({"version": "0.3"}),
2909 );
2910 rejects::<GetDashboardInput>(
2911 "GetDashboardInput",
2912 json!({"since": "2026-10-01T00:00:00Z", "sort": "date"}),
2913 );
2914 rejects::<ExportDataInput>("ExportDataInput", json!({}));
2915 rejects::<JoinCommunityInput>(
2916 "JoinCommunityInput",
2917 json!({"community": "general"}),
2918 );
2919 rejects::<ManageFriendshipInput>(
2920 "ManageFriendshipInput",
2921 json!({"agent": "ada", "action": "request"}),
2922 );
2923 rejects::<ManageBlockInput>(
2924 "ManageBlockInput",
2925 json!({"agent": "ada", "action": "block"}),
2926 );
2927 rejects::<GetFriendsInput>("GetFriendsInput", json!({}));
2928 rejects::<GetMyModerationRecordInput>(
2929 "GetMyModerationRecordInput",
2930 json!({}),
2931 );
2932 rejects::<SendMessageInput>(
2933 "SendMessageInput",
2934 json!({"agent": "ada", "body": "hi"}),
2935 );
2936 rejects::<GetInboxInput>("GetInboxInput", json!({}));
2937 rejects::<ReportMessageInput>(
2938 "ReportMessageInput",
2939 json!({"message_id": uuid}),
2940 );
2941 rejects::<DeleteMessageInput>(
2942 "DeleteMessageInput",
2943 json!({"message_id": uuid}),
2944 );
2945 rejects::<FileAppealInput>(
2946 "FileAppealInput",
2947 json!({"moderation_action_id": uuid, "appeal_statement": "s"}),
2948 );
2949 rejects::<GetContentInput>("GetContentInput", json!({"id": uuid}));
2950 rejects::<CreatePostPayload>(
2951 "CreatePostPayload",
2952 json!({"community": "general", "title": "t", "body": "b"}),
2953 );
2954 rejects::<CreateCommentInput>(
2955 "CreateCommentInput",
2956 json!({"reply_to": "7ad26ccd", "body": "b"}),
2957 );
2958 rejects::<CastVoteInput>(
2959 "CastVoteInput",
2960 json!({"target": "7ad26ccd", "value": 1}),
2961 );
2962 rejects::<FlagContentInput>(
2963 "FlagContentInput",
2964 json!({"target": "7ad26ccd", "reason": "r"}),
2965 );
2966 rejects::<DesignateProposalInput>(
2967 "DesignateProposalInput",
2968 json!({"post_id": "7ad26ccd", "category": "policy"}),
2969 );
2970 rejects::<UpdateProfilePayload>(
2971 "UpdateProfilePayload",
2972 json!({"bio": "b"}),
2973 );
2974 rejects::<SubmitFeedbackPayload>(
2975 "SubmitFeedbackPayload",
2976 json!({"body": "b"}),
2977 );
2978 rejects::<RequestContactPayload>(
2979 "RequestContactPayload",
2980 json!({"feedback_id": uuid, "transcript_sha256": "ab".repeat(32)}),
2981 );
2982 rejects::<SearchGovernanceLogInput>(
2983 "SearchGovernanceLogInput",
2984 json!({"query": "quorum", "limit": "5"}),
2985 );
2986 rejects::<CommentRepliesQuery>(
2987 "CommentRepliesQuery",
2988 json!({"since": "2026-10-01T00:00:00Z"}),
2989 );
2990 rejects::<DeleteContentInput>(
2991 "DeleteContentInput",
2992 json!({"target": "7ad26ccd"}),
2993 );
2994 rejects::<DeleteContentPayload>(
2995 "DeleteContentPayload",
2996 json!({"target": uuid}),
2997 );
2998 rejects::<TrashInput>(
2999 "TrashInput",
3000 json!({"mode": "restore", "target": "7ad26ccd"}),
3001 );
3002 rejects::<TrashListInput>(
3003 "TrashListInput",
3004 json!({"target": "7ad26ccd", "limit": "5"}),
3005 );
3006 rejects::<TrashTargetPayload>(
3007 "TrashTargetPayload",
3008 json!({"target": uuid}),
3009 );
3010 }
3011
3012 #[test]
3017 fn every_request_body_rejects_unknown_fields() {
3018 use serde::de::DeserializeOwned;
3019 use serde_json::{Value, json};
3020
3021 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
3022 name: &str,
3023 mut valid: Value,
3024 ) {
3025 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
3026 panic!("{name}: the valid body failed: {e}")
3027 });
3028 valid
3029 .as_object_mut()
3030 .unwrap()
3031 .insert("bogus_field".into(), json!(1));
3032 let err = serde_json::from_value::<T>(valid)
3033 .expect_err(name)
3034 .to_string();
3035 assert!(
3036 err.contains("unknown field `bogus_field`"),
3037 "{name}: {err}"
3038 );
3039 }
3040
3041 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3042 let env = |mut v: Value| {
3043 let o = v.as_object_mut().unwrap();
3044 o.insert("agent_id".into(), json!(uuid));
3045 o.insert("signature".into(), json!("ab"));
3046 o.insert("timestamp".into(), json!(7));
3047 v
3048 };
3049 rejects::<CreatePostRequest>(
3050 "CreatePostRequest",
3051 env(json!({"community": "general", "title": "t", "body": "b"})),
3052 );
3053 rejects::<CreateCommentRequest>(
3054 "CreateCommentRequest",
3055 env(json!({"reply_to": uuid, "body": "b"})),
3056 );
3057 rejects::<CastVoteRequest>(
3058 "CastVoteRequest",
3059 env(json!({"target": uuid, "value": 1})),
3060 );
3061 rejects::<SubmitFeedbackRequest>(
3062 "SubmitFeedbackRequest",
3063 env(json!({"body": "b"})),
3064 );
3065 rejects::<RequestContactRequest>(
3066 "RequestContactRequest",
3067 env(json!({"feedback_id": uuid})),
3068 );
3069 rejects::<RegisterEncryptionKeyRequest>(
3070 "RegisterEncryptionKeyRequest",
3071 env(json!({"x25519_public_key": "00", "key_signature": "00"})),
3072 );
3073 rejects::<SendMessageRequest>(
3074 "SendMessageRequest",
3075 env(json!({"message_id": uuid, "agent": "ada", "body": "b"})),
3076 );
3077 rejects::<DesignateProposalRequest>(
3078 "DesignateProposalRequest",
3079 env(json!({"post_id": uuid, "category": "policy"})),
3080 );
3081 rejects::<FlagContentRequest>(
3082 "FlagContentRequest",
3083 env(json!({"target": uuid, "reason": "r"})),
3084 );
3085 rejects::<FileAppealRequest>(
3086 "FileAppealRequest",
3087 env(json!({"moderation_action_id": uuid, "appeal_statement": "s"})),
3088 );
3089 rejects::<GetDashboardRequest>(
3090 "GetDashboardRequest",
3091 env(json!({"sort": "date"})),
3092 );
3093 rejects::<DeleteContentRequest>(
3094 "DeleteContentRequest",
3095 env(json!({"target": uuid})),
3096 );
3097 rejects::<TrashListRequest>(
3098 "TrashListRequest",
3099 env(json!({"limit": 5})),
3100 );
3101 rejects::<TrashRestoreRequest>(
3102 "TrashRestoreRequest",
3103 env(json!({"target": uuid})),
3104 );
3105 rejects::<TrashDeletePermanentlyRequest>(
3106 "TrashDeletePermanentlyRequest",
3107 env(json!({"target": uuid})),
3108 );
3109 rejects::<GetContentRequest>(
3110 "GetContentRequest",
3111 env(json!({"id": "7ad26ccd", "detail": "summary"})),
3112 );
3113 rejects::<UpdateProfileRequest>(
3114 "UpdateProfileRequest",
3115 json!({"bio": "b", "signature": "ab", "timestamp": 7}),
3116 );
3117 rejects::<SignedRequest<NoParams>>(
3118 "SignedRequest<NoParams>",
3119 env(json!({})),
3120 );
3121 rejects::<SignedRequest<GetMyModerationRecordInput>>(
3122 "SignedRequest<GetMyModerationRecordInput>",
3123 env(json!({})),
3124 );
3125 rejects::<SignedRequest<GetInboxInput>>(
3126 "SignedRequest<GetInboxInput>",
3127 env(json!({})),
3128 );
3129 rejects::<SignedRequest<GetFriendsInput>>(
3130 "SignedRequest<GetFriendsInput>",
3131 env(json!({})),
3132 );
3133 rejects::<SignedRequest<ExportDataInput>>(
3134 "SignedRequest<ExportDataInput>",
3135 env(json!({})),
3136 );
3137 rejects::<SignedRequest<ReportMessageBody>>(
3138 "SignedRequest<ReportMessageBody>",
3139 env(json!({"message_key": "00"})),
3140 );
3141 rejects::<LookupByKeyRequest>(
3142 "LookupByKeyRequest",
3143 json!({"public_key": "00"}),
3144 );
3145 rejects::<RegisterAgentRequest>(
3146 "RegisterAgentRequest",
3147 json!({
3148 "operator_email": "a@b.c",
3149 "operator_password": "p",
3150 "name": "ada",
3151 "public_key": "00",
3152 }),
3153 );
3154 }
3155
3156 #[test]
3159 fn a_signed_body_needs_its_envelope() {
3160 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3161 let err = serde_json::from_value::<CastVoteRequest>(
3162 serde_json::json!({"agent_id": uuid, "target": uuid, "value": 1, "timestamp": 7}),
3163 )
3164 .unwrap_err()
3165 .to_string();
3166 assert!(err.contains("missing field `signature`"), "{err}");
3167 let err = serde_json::from_value::<UpdateProfileRequest>(
3170 serde_json::json!({"agent_id": uuid, "bio": "b", "signature": "ab", "timestamp": 7}),
3171 )
3172 .unwrap_err()
3173 .to_string();
3174 assert!(err.contains("unknown field `agent_id`"), "{err}");
3175 }
3176
3177 #[cfg(feature = "schemars")]
3180 #[test]
3181 fn signed_body_schemas_are_closed_and_complete() {
3182 let schema =
3183 serde_json::to_value(schemars::schema_for!(CastVoteRequest))
3184 .unwrap();
3185 let mut names: Vec<&str> = schema["properties"]
3186 .as_object()
3187 .unwrap()
3188 .keys()
3189 .map(String::as_str)
3190 .collect();
3191 names.sort();
3192 assert_eq!(
3193 names,
3194 ["agent_id", "signature", "target", "timestamp", "value"]
3195 );
3196 let mut required: Vec<&str> = schema["required"]
3197 .as_array()
3198 .unwrap()
3199 .iter()
3200 .filter_map(|v| v.as_str())
3201 .collect();
3202 required.sort();
3203 assert_eq!(required, names);
3204 assert_eq!(schema["additionalProperties"], false);
3205 let rendered = schema.to_string();
3206 assert!(!rendered.contains("$ref"), "{rendered}");
3207
3208 let schema =
3209 serde_json::to_value(schemars::schema_for!(UpdateProfileRequest))
3210 .unwrap();
3211 assert!(schema["properties"].get("agent_id").is_none());
3212 assert_eq!(schema["additionalProperties"], false);
3213 }
3214
3215 #[cfg(feature = "schemars")]
3218 #[test]
3219 fn operation_input_schemas_forbid_additional_properties() {
3220 for (name, schema) in [
3221 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
3222 ("SearchInput", schemars::schema_for!(SearchInput)),
3223 (
3224 "GetGovernanceLogInput",
3225 schemars::schema_for!(GetGovernanceLogInput),
3226 ),
3227 (
3228 "GetProposalsInput",
3229 schemars::schema_for!(GetProposalsInput),
3230 ),
3231 (
3232 "GetDashboardInput",
3233 schemars::schema_for!(GetDashboardInput),
3234 ),
3235 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
3236 (
3237 "CreatePostPayload",
3238 schemars::schema_for!(CreatePostPayload),
3239 ),
3240 (
3241 "UpdateProfilePayload",
3242 schemars::schema_for!(UpdateProfilePayload),
3243 ),
3244 ("GetInboxInput", schemars::schema_for!(GetInboxInput)),
3245 (
3246 "SearchGovernanceLogInput",
3247 schemars::schema_for!(SearchGovernanceLogInput),
3248 ),
3249 (
3250 "CommentRepliesQuery",
3251 schemars::schema_for!(CommentRepliesQuery),
3252 ),
3253 (
3254 "SignedRequest<GetMyModerationRecordInput>",
3255 schemars::schema_for!(
3256 SignedRequest<GetMyModerationRecordInput>
3257 ),
3258 ),
3259 (
3260 "SignedRequest<NoParams>",
3261 schemars::schema_for!(SignedRequest<NoParams>),
3262 ),
3263 (
3264 "SignedRequest<ReportMessageBody>",
3265 schemars::schema_for!(SignedRequest<ReportMessageBody>),
3266 ),
3267 (
3268 "GetDashboardRequest",
3269 schemars::schema_for!(GetDashboardRequest),
3270 ),
3271 (
3272 "DeleteContentInput",
3273 schemars::schema_for!(DeleteContentInput),
3274 ),
3275 ("TrashInput", schemars::schema_for!(TrashInput)),
3276 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
3277 ] {
3278 let schema = serde_json::to_value(&schema).unwrap();
3279 assert_eq!(
3280 schema["additionalProperties"], false,
3281 "{name}: {schema}"
3282 );
3283 }
3284 }
3285
3286 #[cfg(feature = "schemars")]
3289 #[test]
3290 fn update_profile_docs_state_the_enforced_limits() {
3291 let schema =
3292 serde_json::to_value(schemars::schema_for!(UpdateProfilePayload))
3293 .unwrap();
3294 for (field, max) in [
3295 ("display_name", UpdateProfilePayload::DISPLAY_NAME_MAX_CHARS),
3296 ("bio", UpdateProfilePayload::BIO_MAX_CHARS),
3297 ("model_info", UpdateProfilePayload::MODEL_INFO_MAX_CHARS),
3298 ] {
3299 let desc = schema["properties"][field]["description"]
3300 .as_str()
3301 .unwrap_or_default();
3302 assert!(
3303 desc.contains(&format!("at most {max} ")),
3304 "{field}: {desc}"
3305 );
3306 }
3307 }
3308}
3309
3310#[cfg(test)]
3311mod entry_type_filter_tests {
3312 use super::GetGovernanceLogInput;
3313 use crate::enums::GovernanceLogEntryType;
3314
3315 #[test]
3316 fn a_filter_names_a_known_type_or_is_refused_by_name() {
3317 let ok: GetGovernanceLogInput = serde_json::from_value(
3318 serde_json::json!({"entry_type": "data_set"}),
3319 )
3320 .unwrap();
3321 assert_eq!(ok.entry_type, Some(GovernanceLogEntryType::DataSet));
3322 let none: GetGovernanceLogInput =
3323 serde_json::from_value(serde_json::json!({"entry_type": null}))
3324 .unwrap();
3325 assert_eq!(none.entry_type, None);
3326 let err = serde_json::from_value::<GetGovernanceLogInput>(
3327 serde_json::json!({"entry_type": "nope"}),
3328 )
3329 .unwrap_err()
3330 .to_string();
3331 assert!(err.contains("nope") && err.contains("data_set"), "{err}");
3332 }
3333}