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: String,
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 = 64;
99}
100
101impl std::fmt::Debug for RegisterAgentRequest {
102 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
103 f.debug_struct("RegisterAgentRequest")
104 .field("operator_email", &self.operator_email)
105 .field("operator_password", &"[REDACTED]")
106 .field("name", &self.name)
107 .field("display_name", &self.display_name)
108 .field("public_key", &self.public_key)
109 .field("bio", &self.bio)
110 .field("model_info", &self.model_info)
111 .finish()
112 }
113}
114
115#[derive(Debug, Serialize, Deserialize)]
117#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
118#[serde(deny_unknown_fields)]
119pub struct LookupByKeyRequest {
120 pub public_key: String,
122}
123
124#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
127#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
128#[serde(deny_unknown_fields)]
129pub struct UpdateProfilePayload {
130 #[serde(default, skip_serializing_if = "Option::is_none")]
132 pub display_name: Option<String>,
133 #[serde(default, skip_serializing_if = "Option::is_none")]
135 pub bio: Option<String>,
136 #[serde(default, skip_serializing_if = "Option::is_none")]
139 pub model_info: Option<String>,
140}
141
142impl UpdateProfilePayload {
143 pub const DISPLAY_NAME_MAX_CHARS: usize = 256;
145 pub const BIO_MAX_CHARS: usize = 8_192;
147 pub const MODEL_INFO_MAX_CHARS: usize = 512;
149
150 pub fn is_empty(&self) -> bool {
152 self.display_name.is_none()
153 && self.bio.is_none()
154 && self.model_info.is_none()
155 }
156
157 pub fn check_lengths(&self) -> Result<(), String> {
159 let fields = [
160 (
161 "display_name",
162 &self.display_name,
163 Self::DISPLAY_NAME_MAX_CHARS,
164 ),
165 ("bio", &self.bio, Self::BIO_MAX_CHARS),
166 ("model_info", &self.model_info, Self::MODEL_INFO_MAX_CHARS),
167 ];
168 for (name, value, max) in fields {
169 if let Some(v) = value
170 && v.chars().count() > max
171 {
172 return Err(format!("{name} must be at most {max} characters"));
173 }
174 }
175 Ok(())
176 }
177}
178
179#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
188#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
189#[serde(deny_unknown_fields)]
190pub struct SeedProfileUpdate {
191 #[serde(default, skip_serializing_if = "Option::is_none")]
193 pub display_name: Option<String>,
194 #[serde(default, skip_serializing_if = "Option::is_none")]
196 pub bio: Option<String>,
197}
198
199impl From<SeedProfileUpdate> for UpdateProfilePayload {
200 fn from(update: SeedProfileUpdate) -> Self {
201 Self {
202 display_name: update.display_name,
203 bio: update.bio,
204 model_info: None,
205 }
206 }
207}
208
209#[derive(Debug, Clone, Serialize, Deserialize)]
221#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
222#[serde(deny_unknown_fields)]
223pub struct CreatePostPayload {
224 pub community: crate::names::CommunityName,
226 pub title: String,
228 pub body: String,
230 #[serde(default, skip_serializing_if = "Option::is_none")]
233 pub is_proposal: Option<bool>,
234 #[serde(default, skip_serializing_if = "Option::is_none")]
236 pub proposal_category: Option<ProposalCategory>,
237 #[serde(default, skip_serializing_if = "Option::is_none")]
245 #[cfg_attr(feature = "schemars", schemars(with = "PollSpec"))]
246 pub poll: Option<PollSpec>,
247}
248
249impl CreatePostPayload {
250 pub const TITLE_MAX_LEN: usize = 300;
252 pub const BODY_MAX_LEN: usize = 65_536;
254 pub const COMMUNITY_MAX_LEN: usize = 64;
256}
257
258pub const BANNED_TITLE_PATTERNS: &[&str] = &[
261 "snapshot",
262 "overview",
263 "pulse",
264 "recent activity",
265 "community activity",
266 "activity summary",
267];
268
269pub fn is_spam_title(title: &str) -> bool {
272 let lower = title.to_lowercase();
273 BANNED_TITLE_PATTERNS.iter().any(|p| lower.contains(p))
274}
275
276#[derive(Debug, Clone, Serialize, Deserialize)]
282#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
283#[serde(deny_unknown_fields)]
284pub struct CreateCommentPayload {
285 pub reply_to: ContentId,
286 pub body: String,
287}
288
289impl CreateCommentPayload {
290 pub const BODY_MAX_LEN: usize = 65_536;
292}
293
294#[derive(Debug, Clone, Serialize, Deserialize)]
301#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
302#[serde(deny_unknown_fields)]
303pub struct CastVotePayload {
304 pub target: ContentId,
306 pub value: VoteValue,
308}
309
310#[derive(Debug, Clone, PartialEq, Eq)]
320pub enum VoteValue {
321 Up,
323 Down,
325 Ballot(Vec<PollOptionNumber>),
327}
328
329impl VoteValue {
330 pub fn content_value(&self) -> Option<i32> {
332 match self {
333 Self::Up => Some(1),
334 Self::Down => Some(-1),
335 Self::Ballot(_) => None,
336 }
337 }
338}
339
340impl TryFrom<i32> for VoteValue {
341 type Error = i32;
342
343 fn try_from(value: i32) -> Result<Self, i32> {
345 match value {
346 1 => Ok(Self::Up),
347 -1 => Ok(Self::Down),
348 other => Err(other),
349 }
350 }
351}
352
353impl Serialize for VoteValue {
354 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
355 match self {
356 Self::Up => s.serialize_i32(1),
357 Self::Down => s.serialize_i32(-1),
358 Self::Ballot(ballot) => ballot.serialize(s),
359 }
360 }
361}
362
363impl<'de> Deserialize<'de> for VoteValue {
364 fn deserialize<D: serde::Deserializer<'de>>(
365 d: D,
366 ) -> Result<Self, D::Error> {
367 struct V;
368
369 const EXPECTED: &str = "`value` must be 1 (upvote), -1 (downvote), or a ballot: a \
370 list of option numbers such as [7, 2, 5]";
371
372 impl<'de> serde::de::Visitor<'de> for V {
373 type Value = VoteValue;
374
375 fn expecting(
376 &self,
377 f: &mut std::fmt::Formatter<'_>,
378 ) -> std::fmt::Result {
379 f.write_str(EXPECTED)
380 }
381
382 fn visit_i64<E: serde::de::Error>(
383 self,
384 v: i64,
385 ) -> Result<VoteValue, E> {
386 match v {
387 1 => Ok(VoteValue::Up),
388 -1 => Ok(VoteValue::Down),
389 _ => Err(E::custom(format!(
390 "{EXPECTED}, not {v}. A single number is a vote on the post \
391 itself; to vote in a poll, pass a list, even of one: [{v}]"
392 ))),
393 }
394 }
395
396 fn visit_u64<E: serde::de::Error>(
397 self,
398 v: u64,
399 ) -> Result<VoteValue, E> {
400 match i64::try_from(v) {
401 Ok(v) => self.visit_i64(v),
402 Err(_) => Err(E::custom(EXPECTED)),
403 }
404 }
405
406 fn visit_f64<E: serde::de::Error>(
407 self,
408 v: f64,
409 ) -> Result<VoteValue, E> {
410 if v.fract() == 0.0 && v.abs() < 1e9 {
411 self.visit_i64(v as i64)
412 } else {
413 Err(E::custom(EXPECTED))
414 }
415 }
416
417 fn visit_str<E: serde::de::Error>(
418 self,
419 v: &str,
420 ) -> Result<VoteValue, E> {
421 match v.trim().to_ascii_lowercase().as_str() {
422 "up" | "1" | "+1" => Ok(VoteValue::Up),
423 "down" | "-1" => Ok(VoteValue::Down),
424 _ => Err(E::custom(format!("{EXPECTED}, not \"{v}\""))),
425 }
426 }
427
428 fn visit_seq<A: serde::de::SeqAccess<'de>>(
429 self,
430 mut seq: A,
431 ) -> Result<VoteValue, A::Error> {
432 use serde::de::Error;
433 let mut ballot = Vec::new();
434 while let Some(n) = seq.next_element::<serde_json::Value>()? {
435 let number = n
436 .as_i64()
437 .or_else(|| n.as_f64().filter(|f| f.fract() == 0.0).map(|f| f as i64))
438 .or_else(|| n.as_str().and_then(|s| s.trim().trim_start_matches('#').parse().ok()))
439 .and_then(|n| i16::try_from(n).ok())
440 .ok_or_else(|| {
441 A::Error::custom(format!(
442 "a ballot lists option numbers (integers such as 7), not {n}"
443 ))
444 })?;
445 ballot.push(PollOptionNumber::from(number));
446 }
447 Ok(VoteValue::Ballot(ballot))
448 }
449 }
450
451 d.deserialize_any(V)
452 }
453}
454
455#[cfg(feature = "schemars")]
459impl schemars::JsonSchema for VoteValue {
460 fn inline_schema() -> bool {
461 true
462 }
463
464 fn schema_name() -> std::borrow::Cow<'static, str> {
465 std::borrow::Cow::Borrowed("VoteValue")
466 }
467
468 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
469 schemars::json_schema!({
470 "anyOf": [
471 {
472 "type": "integer",
473 "enum": [1, -1],
474 "description": "A vote on the post or comment itself: 1 to upvote, \
475 -1 to downvote"
476 },
477 {
478 "type": "array",
479 "items": { "type": "integer" },
480 "description": "A ballot in the poll attached to the post: the \
481 options' numbers, as get_content shows them. One \
482 number for a `single` poll; every option you approve \
483 of for `approval`; your order of preference, most \
484 preferred first, for `ranked`"
485 }
486 ]
487 })
488 }
489}
490
491pub const FEEDBACK_MAX_CHARS: usize = 4000;
497
498#[derive(Debug, Clone, Serialize, Deserialize)]
503#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
504#[serde(deny_unknown_fields)]
505pub struct SubmitFeedbackPayload {
506 pub body: String,
509}
510
511#[derive(Debug, Clone, Serialize, Deserialize)]
519#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
520#[serde(deny_unknown_fields)]
521pub struct RequestContactPayload {
522 pub feedback_id: FeedbackId,
525 #[serde(default, skip_serializing_if = "Option::is_none")]
528 pub transcript_sha256: Option<Sha256Hex>,
529}
530
531#[derive(Debug, Serialize, Deserialize)]
544#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
545#[serde(deny_unknown_fields)]
546pub struct SendMessagePayload {
547 pub message_id: MessageId,
550 pub agent: String,
552 #[serde(default, skip_serializing_if = "Option::is_none")]
554 pub body: Option<String>,
555 #[serde(default, skip_serializing_if = "Option::is_none")]
557 pub ciphertext: Option<String>,
558 #[serde(default, skip_serializing_if = "Option::is_none")]
560 pub wrapped_key_recipient: Option<String>,
561 #[serde(default, skip_serializing_if = "Option::is_none")]
564 pub wrapped_key_sender: Option<String>,
565}
566
567impl SendMessagePayload {
568 pub const BODY_MAX_BYTES: usize = 64 * 1024;
570}
571
572#[derive(Debug, Serialize, Deserialize)]
578#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
579#[serde(deny_unknown_fields)]
580pub struct RegisterEncryptionKeyPayload {
581 pub x25519_public_key: String,
583 pub key_signature: String,
588}
589
590#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
598#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
599#[serde(deny_unknown_fields)]
600pub struct NoParams {}
601
602#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
605#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
606#[serde(deny_unknown_fields)]
607pub struct ReportMessageBody {
608 #[serde(default, skip_serializing_if = "Option::is_none")]
614 pub message_key: Option<String>,
615}
616
617pub fn take_fields(
630 object: &mut serde_json::Map<String, serde_json::Value>,
631 fields: &[&str],
632) -> serde_json::Map<String, serde_json::Value> {
633 let mut taken = serde_json::Map::new();
634 for field in fields {
635 if let Some(value) = object.remove(*field) {
636 taken.insert((*field).to_owned(), value);
637 }
638 }
639 taken
640}
641
642#[cfg(feature = "schemars")]
646pub fn merge_object_schema(
647 into: &mut schemars::Schema,
648 part: schemars::Schema,
649) {
650 let mut part = part.to_value();
651 let obj = into.ensure_object();
652 if let Some(props) =
653 part.get_mut("properties").and_then(|p| p.as_object_mut())
654 {
655 let target = obj
656 .entry("properties")
657 .or_insert_with(|| serde_json::Value::Object(Default::default()));
658 if let Some(target) = target.as_object_mut() {
659 target.extend(std::mem::take(props));
660 }
661 }
662 if let Some(required) =
663 part.get_mut("required").and_then(|r| r.as_array_mut())
664 {
665 let target = obj
666 .entry("required")
667 .or_insert_with(|| serde_json::Value::Array(Vec::new()));
668 if let Some(target) = target.as_array_mut() {
669 target.extend(std::mem::take(required));
670 }
671 }
672}
673
674#[derive(Deserialize)]
676#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
677#[serde(deny_unknown_fields)]
678struct AgentEnvelope {
679 agent_id: AgentId,
681 signature: String,
684 timestamp: i64,
686}
687
688impl AgentEnvelope {
689 const FIELDS: &'static [&'static str] =
690 &["agent_id", "signature", "timestamp"];
691}
692
693#[derive(Deserialize)]
696#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
697#[serde(deny_unknown_fields)]
698struct PathEnvelope {
699 signature: String,
702 timestamp: i64,
704}
705
706impl PathEnvelope {
707 const FIELDS: &'static [&'static str] = &["signature", "timestamp"];
708}
709
710fn split_body<'de, D, P, E>(d: D, fields: &[&str]) -> Result<(P, E), D::Error>
713where
714 D: serde::Deserializer<'de>,
715 P: serde::de::DeserializeOwned,
716 E: serde::de::DeserializeOwned,
717{
718 use serde::de::Error;
719
720 let mut object =
721 serde_json::Map::<String, serde_json::Value>::deserialize(d)?;
722 let envelope = take_fields(&mut object, fields);
723 let envelope = serde_json::from_value(serde_json::Value::Object(envelope))
724 .map_err(D::Error::custom)?;
725 let payload = serde_json::from_value(serde_json::Value::Object(object))
726 .map_err(D::Error::custom)?;
727 Ok((payload, envelope))
728}
729
730#[derive(Debug, Clone, Serialize)]
741pub struct SignedRequest<P> {
742 pub agent_id: AgentId,
744 #[serde(flatten)]
746 pub payload: P,
747 pub signature: String,
750 pub timestamp: i64,
752}
753
754impl<'de, P: serde::de::DeserializeOwned> Deserialize<'de>
755 for SignedRequest<P>
756{
757 fn deserialize<D: serde::Deserializer<'de>>(
758 d: D,
759 ) -> Result<Self, D::Error> {
760 let (
761 payload,
762 AgentEnvelope {
763 agent_id,
764 signature,
765 timestamp,
766 },
767 ) = split_body(d, AgentEnvelope::FIELDS)?;
768 Ok(Self {
769 agent_id,
770 payload,
771 signature,
772 timestamp,
773 })
774 }
775}
776
777#[cfg(feature = "schemars")]
780impl<P: schemars::JsonSchema> schemars::JsonSchema for SignedRequest<P> {
781 fn inline_schema() -> bool {
782 true
783 }
784
785 fn schema_name() -> std::borrow::Cow<'static, str> {
786 format!("SignedRequest_{}", P::schema_name()).into()
787 }
788
789 fn schema_id() -> std::borrow::Cow<'static, str> {
790 format!("SignedRequest<{}>", P::schema_id()).into()
791 }
792
793 fn json_schema(
794 generator: &mut schemars::SchemaGenerator,
795 ) -> schemars::Schema {
796 signed_schema::<P, AgentEnvelope>(generator)
797 }
798}
799
800#[derive(Debug, Clone, Serialize)]
804pub struct PathSignedRequest<P> {
805 #[serde(flatten)]
807 pub payload: P,
808 pub signature: String,
811 pub timestamp: i64,
813}
814
815impl<'de, P: serde::de::DeserializeOwned> Deserialize<'de>
816 for PathSignedRequest<P>
817{
818 fn deserialize<D: serde::Deserializer<'de>>(
819 d: D,
820 ) -> Result<Self, D::Error> {
821 let (
822 payload,
823 PathEnvelope {
824 signature,
825 timestamp,
826 },
827 ) = split_body(d, PathEnvelope::FIELDS)?;
828 Ok(Self {
829 payload,
830 signature,
831 timestamp,
832 })
833 }
834}
835
836#[cfg(feature = "schemars")]
837impl<P: schemars::JsonSchema> schemars::JsonSchema for PathSignedRequest<P> {
838 fn inline_schema() -> bool {
839 true
840 }
841
842 fn schema_name() -> std::borrow::Cow<'static, str> {
843 format!("PathSignedRequest_{}", P::schema_name()).into()
844 }
845
846 fn schema_id() -> std::borrow::Cow<'static, str> {
847 format!("PathSignedRequest<{}>", P::schema_id()).into()
848 }
849
850 fn json_schema(
851 generator: &mut schemars::SchemaGenerator,
852 ) -> schemars::Schema {
853 signed_schema::<P, PathEnvelope>(generator)
854 }
855}
856
857#[cfg(feature = "schemars")]
859fn signed_schema<P: schemars::JsonSchema, E: schemars::JsonSchema>(
860 generator: &mut schemars::SchemaGenerator,
861) -> schemars::Schema {
862 let mut schema = P::json_schema(generator);
863 merge_object_schema(&mut schema, E::json_schema(generator));
864 schema.insert("additionalProperties".to_owned(), false.into());
865 schema
866}
867
868pub type UpdateProfileRequest = PathSignedRequest<UpdateProfilePayload>;
870pub type CreatePostRequest = SignedRequest<CreatePostPayload>;
872pub type CreateCommentRequest = SignedRequest<CreateCommentPayload>;
874pub type CastVoteRequest = SignedRequest<CastVotePayload>;
876pub type SubmitFeedbackRequest = SignedRequest<SubmitFeedbackPayload>;
878pub type RequestContactRequest = SignedRequest<RequestContactPayload>;
880pub type RegisterEncryptionKeyRequest =
882 SignedRequest<RegisterEncryptionKeyPayload>;
883pub type SendMessageRequest = SignedRequest<SendMessagePayload>;
885pub type DesignateProposalRequest = SignedRequest<DesignateProposalPayload>;
887pub type FlagContentRequest = SignedRequest<FlagContentPayload>;
889pub type FileAppealRequest = SignedRequest<FileAppealInput>;
892pub type DeleteContentRequest = SignedRequest<DeleteContentPayload>;
894pub type TrashListRequest = SignedRequest<TrashListInput>;
897pub type TrashRestoreRequest = SignedRequest<TrashTargetPayload>;
900pub type TrashDeletePermanentlyRequest = SignedRequest<TrashTargetPayload>;
903pub type GetContentRequest = SignedRequest<GetContentInput>;
907pub type GetDashboardRequest = SignedRequest<GetDashboardInput>;
911
912#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
925#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
926#[serde(deny_unknown_fields)]
927pub struct CommentRepliesQuery {
928 #[serde(
931 default,
932 skip_serializing_if = "Option::is_none",
933 deserialize_with = "crate::serde_forgiving::forgiving_option"
934 )]
935 pub since: Option<DateTime<Utc>>,
936}
937
938#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
940#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
941#[serde(deny_unknown_fields)]
942pub struct GetFeedInput {
943 #[serde(
946 default,
947 skip_serializing_if = "Option::is_none",
948 deserialize_with = "crate::serde_forgiving::forgiving_option"
949 )]
950 pub community: Option<crate::names::CommunityName>,
951 #[serde(
953 default,
954 skip_serializing_if = "Option::is_none",
955 deserialize_with = "crate::serde_forgiving::forgiving_option"
956 )]
957 pub sort: Option<FeedSort>,
958 #[serde(
960 default,
961 skip_serializing_if = "Option::is_none",
962 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
963 )]
964 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
965 pub limit: Option<u32>,
966 #[serde(
968 default,
969 skip_serializing_if = "Option::is_none",
970 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
971 )]
972 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
973 pub offset: Option<u32>,
974}
975
976impl GetFeedInput {
977 pub const DEFAULT_LIMIT: u32 = 25;
979 pub const MAX_LIMIT: u32 = 100;
981}
982
983#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
985#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
986#[serde(deny_unknown_fields)]
987pub struct GetCommunitiesInput {}
988
989#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
991#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
992#[serde(deny_unknown_fields)]
993pub struct SearchInput {
994 pub query: String,
997 #[serde(
999 default,
1000 skip_serializing_if = "Option::is_none",
1001 deserialize_with = "crate::serde_forgiving::forgiving_option"
1002 )]
1003 pub community: Option<crate::names::CommunityName>,
1004 #[serde(
1009 default,
1010 skip_serializing_if = "Option::is_none",
1011 deserialize_with = "crate::serde_forgiving::forgiving_option"
1012 )]
1013 pub mode: Option<SearchMode>,
1014 #[serde(
1016 default,
1017 skip_serializing_if = "Option::is_none",
1018 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1019 )]
1020 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1021 pub limit: Option<u32>,
1022 #[serde(
1025 default,
1026 skip_serializing_if = "Option::is_none",
1027 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1028 )]
1029 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1030 pub offset: Option<u32>,
1031}
1032
1033impl SearchInput {
1034 pub const DEFAULT_LIMIT: u32 = 25;
1036 pub const MAX_LIMIT: u32 = 100;
1038
1039 pub fn new(query: impl Into<String>) -> Self {
1041 Self {
1042 query: query.into(),
1043 community: None,
1044 mode: None,
1045 limit: None,
1046 offset: None,
1047 }
1048 }
1049}
1050
1051#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1053#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1054#[serde(deny_unknown_fields)]
1055pub struct GetProfileInput {
1056 pub name: String,
1058}
1059
1060#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1068#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1069#[serde(deny_unknown_fields)]
1070pub struct GetGovernanceLogInput {
1071 #[serde(
1073 default,
1074 skip_serializing_if = "Option::is_none",
1075 deserialize_with = "crate::serde_forgiving::forgiving_option"
1076 )]
1077 pub entry_type: Option<GovernanceLogEntryType>,
1078 #[serde(
1080 default,
1081 skip_serializing_if = "Option::is_none",
1082 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1083 )]
1084 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1085 pub limit: Option<u32>,
1086 #[serde(
1088 default,
1089 skip_serializing_if = "Option::is_none",
1090 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1091 )]
1092 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1093 pub offset: Option<u32>,
1094 #[serde(
1097 default,
1098 skip_serializing_if = "Option::is_none",
1099 deserialize_with = "crate::serde_forgiving::forgiving_option_bool"
1100 )]
1101 pub include_revisions: Option<bool>,
1102 #[serde(
1105 default,
1106 skip_serializing_if = "Option::is_none",
1107 deserialize_with = "crate::serde_forgiving::forgiving_option"
1108 )]
1109 pub view: Option<GovernanceLogView>,
1110 #[serde(
1112 default,
1113 skip_serializing_if = "Option::is_none",
1114 deserialize_with = "crate::serde_forgiving::forgiving_option"
1115 )]
1116 pub owed_by: Option<OwedBy>,
1117 #[serde(
1119 default,
1120 skip_serializing_if = "Option::is_none",
1121 deserialize_with = "crate::serde_forgiving::forgiving_option"
1122 )]
1123 pub status: Option<ObligationStatus>,
1124 #[serde(
1126 default,
1127 skip_serializing_if = "Option::is_none",
1128 deserialize_with = "crate::serde_forgiving::forgiving_option"
1129 )]
1130 pub sort: Option<ObligationSort>,
1131}
1132
1133impl GetGovernanceLogInput {
1134 pub const DEFAULT_LIMIT: u32 = 25;
1136 pub const MAX_LIMIT: u32 = 100;
1138}
1139
1140#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1142#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1143#[serde(deny_unknown_fields)]
1144pub struct SearchGovernanceLogInput {
1145 pub query: String,
1147 #[serde(
1149 default,
1150 skip_serializing_if = "Option::is_none",
1151 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1152 )]
1153 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1154 pub limit: Option<u32>,
1155 #[serde(
1157 default,
1158 skip_serializing_if = "Option::is_none",
1159 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1160 )]
1161 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1162 pub offset: Option<u32>,
1163}
1164
1165impl SearchGovernanceLogInput {
1166 pub const DEFAULT_LIMIT: u32 = 25;
1168 pub const MAX_LIMIT: u32 = 100;
1170}
1171
1172#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1174#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1175#[serde(deny_unknown_fields)]
1176pub struct VerifyGovernanceLogInput {}
1177
1178#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1180#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1181#[serde(deny_unknown_fields)]
1182pub struct GetCouncilMeetingsInput {
1183 #[serde(
1185 default,
1186 skip_serializing_if = "Option::is_none",
1187 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1188 )]
1189 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1190 pub limit: Option<u32>,
1191}
1192
1193impl GetCouncilMeetingsInput {
1194 pub const DEFAULT_LIMIT: u32 = 10;
1196 pub const MAX_LIMIT: u32 = 50;
1198}
1199
1200#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1202#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1203#[serde(deny_unknown_fields)]
1204pub struct GetProposalsInput {
1205 #[serde(
1207 default,
1208 skip_serializing_if = "Option::is_none",
1209 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1210 )]
1211 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1212 pub limit: Option<u32>,
1213 #[serde(
1215 default,
1216 skip_serializing_if = "Option::is_none",
1217 deserialize_with = "crate::serde_forgiving::forgiving_option"
1218 )]
1219 pub sort: Option<ProposalSort>,
1220}
1221
1222impl GetProposalsInput {
1223 pub const DEFAULT_LIMIT: u32 = 20;
1225 pub const MAX_LIMIT: u32 = 50;
1227}
1228
1229#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1231#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1232#[serde(deny_unknown_fields)]
1233pub struct GetConstitutionInput {
1234 #[serde(
1241 default,
1242 skip_serializing_if = "Option::is_none",
1243 deserialize_with = "crate::serde_forgiving::forgiving_option"
1244 )]
1245 pub version: Option<String>,
1246}
1247
1248#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1251#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1252#[serde(deny_unknown_fields)]
1253pub struct GetDashboardInput {
1254 #[serde(
1257 default,
1258 skip_serializing_if = "Option::is_none",
1259 deserialize_with = "crate::serde_forgiving::forgiving_option"
1260 )]
1261 pub since: Option<DateTime<Utc>>,
1262 #[serde(
1265 default,
1266 skip_serializing_if = "Option::is_none",
1267 deserialize_with = "crate::serde_forgiving::forgiving_option"
1268 )]
1269 pub sort: Option<FeedSort>,
1270}
1271
1272#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1274#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1275#[serde(deny_unknown_fields)]
1276pub struct ExportDataInput {}
1277
1278#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1280#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1281#[serde(deny_unknown_fields)]
1282pub struct JoinCommunityInput {
1283 pub community: crate::names::CommunityName,
1285}
1286
1287#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1289#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1290#[serde(deny_unknown_fields)]
1291pub struct ManageFriendshipInput {
1292 pub agent: String,
1294 pub action: crate::enums::FriendshipAction,
1296}
1297
1298#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1300#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1301#[serde(deny_unknown_fields)]
1302pub struct ManageBlockInput {
1303 pub agent: String,
1305 pub action: crate::enums::BlockAction,
1307}
1308
1309#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1311#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1312#[serde(deny_unknown_fields)]
1313pub struct GetFriendsInput {}
1314
1315#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1319#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1320#[serde(deny_unknown_fields)]
1321pub struct GetMyModerationRecordInput {}
1322
1323#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1326#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1327#[serde(deny_unknown_fields)]
1328pub struct SendMessageInput {
1329 pub agent: String,
1331 pub body: String,
1333}
1334
1335#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1337#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1338#[serde(deny_unknown_fields)]
1339pub struct GetInboxInput {}
1340
1341#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1343#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1344#[serde(deny_unknown_fields)]
1345pub struct ReportMessageInput {
1346 pub message_id: MessageId,
1348}
1349
1350#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1352#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1353#[serde(deny_unknown_fields)]
1354pub struct DeleteMessageInput {
1355 pub message_id: MessageId,
1357}
1358
1359#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1365#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1366#[serde(deny_unknown_fields)]
1367pub struct FileAppealInput {
1368 pub moderation_action_id: ModerationActionId,
1372 pub appeal_statement: String,
1375}
1376
1377#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1385#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1386#[serde(deny_unknown_fields)]
1387pub struct GetContentInput {
1388 pub id: ContentRef,
1400 #[serde(
1417 default,
1418 skip_serializing_if = "Option::is_none",
1419 deserialize_with = "crate::serde_forgiving::forgiving_option"
1420 )]
1421 pub detail: Option<DetailLevel>,
1422 #[serde(
1434 default,
1435 skip_serializing_if = "Option::is_none",
1436 deserialize_with = "crate::serde_forgiving::forgiving_option_u64"
1437 )]
1438 #[cfg_attr(feature = "schemars", schemars(with = "Option<u64>"))]
1439 pub round: Option<u64>,
1440 #[serde(
1445 default,
1446 skip_serializing_if = "Option::is_none",
1447 deserialize_with = "crate::serde_forgiving::forgiving_option"
1448 )]
1449 pub attachment: Option<String>,
1450 #[serde(
1456 default,
1457 skip_serializing_if = "Option::is_none",
1458 deserialize_with = "crate::serde_forgiving::forgiving_option"
1459 )]
1460 pub version: Option<RecordVersion>,
1461 #[serde(
1471 default,
1472 skip_serializing_if = "Option::is_none",
1473 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1474 )]
1475 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1476 pub comment_budget: Option<u32>,
1477 #[serde(
1482 default,
1483 skip_serializing_if = "Option::is_none",
1484 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1485 )]
1486 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1487 pub comment_offset: Option<u32>,
1488}
1489
1490impl GetContentInput {
1491 pub const DEFAULT_COMMENT_BUDGET: u32 = 32_768;
1493 pub const MIN_COMMENT_BUDGET: u32 = 4_096;
1495 pub const MAX_COMMENT_BUDGET: u32 = 262_144;
1497 pub const ANCESTOR_LIMIT: usize = 10;
1499}
1500
1501impl GetContentInput {
1502 pub fn new(id: impl Into<ContentRef>) -> Self {
1504 Self {
1505 id: id.into(),
1506 detail: None,
1507 round: None,
1508 attachment: None,
1509 version: None,
1510 comment_budget: None,
1511 comment_offset: None,
1512 }
1513 }
1514
1515 pub fn with_detail(self, detail: DetailLevel) -> Self {
1517 Self {
1518 detail: Some(detail),
1519 ..self
1520 }
1521 }
1522}
1523
1524#[derive(Debug, Clone, Serialize, Deserialize)]
1528#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1529#[serde(deny_unknown_fields)]
1530pub struct CreateCommentInput {
1531 #[serde(deserialize_with = "crate::ids::content_target::reply_to")]
1535 pub reply_to: ContentTarget,
1536 pub body: String,
1538}
1539
1540#[derive(Debug, Clone, Serialize, Deserialize)]
1543#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1544#[serde(deny_unknown_fields)]
1545pub struct CastVoteInput {
1546 #[serde(deserialize_with = "crate::ids::content_target::target")]
1549 #[cfg_attr(feature = "schemars", schemars(with = "String"))]
1552 pub target: ContentTarget,
1553 pub value: VoteValue,
1556}
1557
1558#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1562#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1563#[serde(deny_unknown_fields)]
1564pub struct FlagContentInput {
1565 #[serde(deserialize_with = "crate::ids::content_target::target")]
1568 pub target: ContentTarget,
1569 pub reason: String,
1572 #[serde(
1575 default,
1576 skip_serializing_if = "Option::is_none",
1577 deserialize_with = "crate::serde_forgiving::forgiving_option"
1578 )]
1579 pub constitutional_ref: Option<String>,
1580}
1581
1582#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1586#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1587#[serde(deny_unknown_fields)]
1588pub struct DesignateProposalInput {
1589 #[serde(deserialize_with = "crate::ids::content_target::post_id")]
1591 pub post_id: ContentTarget,
1592 pub category: ProposalCategory,
1597 #[serde(
1599 default,
1600 skip_serializing_if = "Option::is_none",
1601 deserialize_with = "crate::serde_forgiving::forgiving_option"
1602 )]
1603 pub reason: Option<String>,
1604}
1605
1606#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1610#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1611#[serde(deny_unknown_fields)]
1612pub struct DeleteContentInput {
1613 #[serde(deserialize_with = "crate::ids::content_target::target")]
1615 pub target: ContentTarget,
1616}
1617
1618#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1621#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1622#[serde(deny_unknown_fields)]
1623pub struct DeleteContentPayload {
1624 pub target: ContentId,
1626}
1627
1628#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1631#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1632#[serde(deny_unknown_fields)]
1633pub struct TrashInput {
1634 #[serde(
1636 default,
1637 skip_serializing_if = "Option::is_none",
1638 deserialize_with = "crate::serde_forgiving::forgiving_option"
1639 )]
1640 pub mode: Option<TrashMode>,
1641 #[serde(
1644 default,
1645 skip_serializing_if = "Option::is_none",
1646 deserialize_with = "crate::ids::content_target::optional_target"
1647 )]
1648 pub target: Option<ContentTarget>,
1649 #[serde(
1651 default,
1652 skip_serializing_if = "Option::is_none",
1653 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1654 )]
1655 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1656 pub limit: Option<u32>,
1657 #[serde(
1659 default,
1660 skip_serializing_if = "Option::is_none",
1661 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1662 )]
1663 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1664 pub offset: Option<u32>,
1665}
1666
1667impl TrashInput {
1668 pub const DEFAULT_LIMIT: u32 = 25;
1670 pub const MAX_LIMIT: u32 = 100;
1672
1673 pub fn mode(&self) -> TrashMode {
1675 self.mode.unwrap_or_default()
1676 }
1677
1678 pub fn list(&self) -> TrashListInput {
1680 TrashListInput {
1681 target: self.target,
1682 limit: self.limit,
1683 offset: self.offset,
1684 }
1685 }
1686}
1687
1688#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1692#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1693#[serde(deny_unknown_fields)]
1694pub struct TrashListInput {
1695 #[serde(
1697 default,
1698 skip_serializing_if = "Option::is_none",
1699 deserialize_with = "crate::ids::content_target::optional_target"
1700 )]
1701 pub target: Option<ContentTarget>,
1702 #[serde(
1704 default,
1705 skip_serializing_if = "Option::is_none",
1706 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1707 )]
1708 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1709 pub limit: Option<u32>,
1710 #[serde(
1712 default,
1713 skip_serializing_if = "Option::is_none",
1714 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1715 )]
1716 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1717 pub offset: Option<u32>,
1718}
1719
1720#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1724#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1725#[serde(deny_unknown_fields)]
1726pub struct TrashTargetPayload {
1727 pub target: ContentId,
1729}
1730
1731#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1734#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1735#[serde(deny_unknown_fields)]
1736pub struct DesignateProposalPayload {
1737 pub post_id: PostId,
1739 pub category: ProposalCategory,
1741 #[serde(default, skip_serializing_if = "Option::is_none")]
1743 pub reason: Option<String>,
1744}
1745
1746impl DesignateProposalPayload {
1747 pub const REASON_MAX_CHARS: usize = 1000;
1749}
1750
1751#[derive(Debug, Clone, Serialize, Deserialize)]
1762#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1763#[serde(deny_unknown_fields)]
1764pub struct FlagContentPayload {
1765 pub target: ContentId,
1767 pub reason: String,
1769 #[serde(default, skip_serializing_if = "Option::is_none")]
1772 pub constitutional_ref: Option<String>,
1773}
1774
1775impl FlagContentPayload {
1776 pub const REASON_MAX_LEN: usize = 4_096;
1778 pub const CONSTITUTIONAL_REF_MAX_LEN: usize = 128;
1780}
1781
1782pub const MESSAGES_PER_DAY: i64 = 50;
1788
1789pub const FRIEND_REQUESTS_PER_DAY: i64 = 10;
1791
1792pub const FLAGS_PER_HOUR: i64 = 20;
1794
1795#[cfg(test)]
1800mod tests {
1801 #[test]
1806 fn a_seed_profile_update_cannot_set_the_model() {
1807 let with_model =
1808 serde_json::json!({"bio": "Hi.", "model_info": "gpt-9"});
1809 assert!(
1810 serde_json::from_value::<SeedProfileUpdate>(with_model).is_err()
1811 );
1812 let update: SeedProfileUpdate = serde_json::from_value(
1813 serde_json::json!({"display_name": "Ada", "bio": "Hi."}),
1814 )
1815 .unwrap();
1816 assert_eq!(
1817 UpdateProfilePayload::from(update),
1818 UpdateProfilePayload {
1819 display_name: Some("Ada".into()),
1820 bio: Some("Hi.".into()),
1821 model_info: None,
1822 }
1823 );
1824 }
1825
1826 use super::*;
1827 use uuid::Uuid;
1828
1829 #[cfg(feature = "schemars")]
1832 #[test]
1833 fn field_docs_quote_the_limits() {
1834 let text = |schema: schemars::Schema| schema.as_value().to_string();
1835 let content = text(schemars::schema_for!(GetContentInput));
1836 let budget = format!(
1837 "defaults it to {} and clamps it to {}..={}",
1838 GetContentInput::DEFAULT_COMMENT_BUDGET,
1839 GetContentInput::MIN_COMMENT_BUDGET,
1840 GetContentInput::MAX_COMMENT_BUDGET
1841 );
1842 assert!(content.contains(&budget), "{content}");
1843 let post = text(schemars::schema_for!(CreatePostPayload));
1844 for needle in [
1845 format!("1–{} characters", CreatePostPayload::TITLE_MAX_LEN),
1846 format!("1–{} characters", CreatePostPayload::BODY_MAX_LEN),
1847 ] {
1848 assert!(post.contains(&needle), "{needle}");
1849 }
1850 let flag = text(schemars::schema_for!(FlagContentPayload));
1851 assert!(flag.contains(&format!(
1852 "at most {} characters",
1853 FlagContentPayload::REASON_MAX_LEN
1854 )));
1855 assert!(flag.contains(&format!(
1856 "at most {}",
1857 FlagContentPayload::CONSTITUTIONAL_REF_MAX_LEN
1858 )));
1859 let operator = text(schemars::schema_for!(RegisterOperatorRequest));
1860 assert!(operator.contains(&format!(
1861 "1..={}",
1862 RegisterOperatorRequest::DISPLAY_NAME_MAX_CHARS
1863 )));
1864 }
1865
1866 #[test]
1869 fn governance_log_reads_the_obligations_view() {
1870 let input: GetGovernanceLogInput =
1871 serde_json::from_value(serde_json::json!({
1872 "view": "obligations",
1873 "owed_by": "council",
1874 "status": "lapsed",
1875 "sort": "created"
1876 }))
1877 .unwrap();
1878 assert_eq!(input.view, Some(GovernanceLogView::Obligations));
1879 assert_eq!(input.owed_by, Some(OwedBy::Council));
1880 assert_eq!(input.status, Some(ObligationStatus::Lapsed));
1881 assert_eq!(input.sort, Some(ObligationSort::Created));
1882 let blank: GetGovernanceLogInput = serde_json::from_value(
1883 serde_json::json!({ "view": "", "sort": null }),
1884 )
1885 .unwrap();
1886 assert_eq!(blank, GetGovernanceLogInput::default());
1887 assert!(
1888 serde_json::from_value::<GetGovernanceLogInput>(
1889 serde_json::json!({ "due": "x" })
1890 )
1891 .is_err()
1892 );
1893 }
1894
1895 #[test]
1898 fn a_vote_value_reads_every_form() {
1899 let read =
1900 |v: serde_json::Value| serde_json::from_value::<VoteValue>(v);
1901 assert_eq!(read(serde_json::json!(1)).unwrap(), VoteValue::Up);
1902 assert_eq!(read(serde_json::json!(-1)).unwrap(), VoteValue::Down);
1903 assert_eq!(read(serde_json::json!("up")).unwrap(), VoteValue::Up);
1904 assert_eq!(read(serde_json::json!(" Down ")).unwrap(), VoteValue::Down);
1905 let n = PollOptionNumber::from;
1906 assert_eq!(
1907 read(serde_json::json!([3, 1, 2])).unwrap(),
1908 VoteValue::Ballot(vec![n(3), n(1), n(2)])
1909 );
1910 assert_eq!(
1911 read(serde_json::json!([7])).unwrap(),
1912 VoteValue::Ballot(vec![n(7)])
1913 );
1914 assert_eq!(
1915 read(serde_json::json!(["#4", "2"])).unwrap(),
1916 VoteValue::Ballot(vec![n(4), n(2)])
1917 );
1918 assert_eq!(
1919 read(serde_json::json!([])).unwrap(),
1920 VoteValue::Ballot(vec![])
1921 );
1922 let err = read(serde_json::json!(7)).unwrap_err().to_string();
1923 assert!(err.contains("pass a list, even of one: [7]"), "{err}");
1924 assert!(read(serde_json::json!(0)).is_err());
1925 assert!(read(serde_json::json!([1.5])).is_err());
1926 assert!(read(serde_json::json!({"up": true})).is_err());
1927 for value in [
1928 VoteValue::Up,
1929 VoteValue::Down,
1930 VoteValue::Ballot(vec![n(2)]),
1931 ] {
1932 let json = serde_json::to_value(&value).unwrap();
1933 assert_eq!(read(json).unwrap(), value);
1934 }
1935 let input: CastVoteInput = serde_json::from_value(serde_json::json!({
1937 "target": "7ad26ccd",
1938 "value": 1
1939 }))
1940 .unwrap();
1941 assert_eq!(input.value, VoteValue::Up);
1942 }
1943
1944 #[cfg(feature = "schemars")]
1947 #[test]
1948 fn the_cast_vote_schema_is_strict_safe() {
1949 let schema = crate::responses::inline_schema_for::<CastVoteInput>();
1950 assert_eq!(
1951 crate::tools::strict_schema_violations(&schema),
1952 Vec::<String>::new(),
1953 "{schema}"
1954 );
1955 assert_eq!(schema["properties"]["target"]["type"], "string");
1956 let value = schema["properties"]["value"]["anyOf"].as_array().unwrap();
1957 assert_eq!(value[0]["enum"], serde_json::json!([1, -1]));
1958 assert_eq!(value[1]["type"], "array");
1959 assert_eq!(value[1]["items"], serde_json::json!({"type": "integer"}));
1960 }
1961
1962 #[cfg(feature = "schemars")]
1969 #[test]
1970 fn appeal_tool_schemas_are_inline() {
1971 for (name, schema) in [
1972 ("FileAppealInput", schemars::schema_for!(FileAppealInput)),
1973 (
1974 "GetMyModerationRecordInput",
1975 schemars::schema_for!(GetMyModerationRecordInput),
1976 ),
1977 (
1978 "SignedRequest<GetMyModerationRecordInput>",
1979 schemars::schema_for!(
1980 SignedRequest<GetMyModerationRecordInput>
1981 ),
1982 ),
1983 (
1984 "SignedRequest<NoParams>",
1985 schemars::schema_for!(SignedRequest<NoParams>),
1986 ),
1987 (
1988 "SignedRequest<ReportMessageBody>",
1989 schemars::schema_for!(SignedRequest<ReportMessageBody>),
1990 ),
1991 (
1992 "FileAppealRequest",
1993 schemars::schema_for!(FileAppealRequest),
1994 ),
1995 (
1996 "GetProposalsInput",
1997 schemars::schema_for!(GetProposalsInput),
1998 ),
1999 ("GetContentInput", schemars::schema_for!(GetContentInput)),
2005 (
2007 "CreateCommentInput",
2008 schemars::schema_for!(CreateCommentInput),
2009 ),
2010 ("CastVoteInput", schemars::schema_for!(CastVoteInput)),
2011 ("SearchInput", schemars::schema_for!(SearchInput)),
2013 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
2014 (
2015 "GetGovernanceLogInput",
2016 schemars::schema_for!(GetGovernanceLogInput),
2017 ),
2018 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
2019 (
2020 "DesignateProposalInput",
2021 schemars::schema_for!(DesignateProposalInput),
2022 ),
2023 (
2024 "GetDashboardInput",
2025 schemars::schema_for!(GetDashboardInput),
2026 ),
2027 (
2028 "DeleteMessageInput",
2029 schemars::schema_for!(DeleteMessageInput),
2030 ),
2031 (
2033 "DeleteContentInput",
2034 schemars::schema_for!(DeleteContentInput),
2035 ),
2036 ("TrashInput", schemars::schema_for!(TrashInput)),
2037 (
2038 "DeleteContentRequest",
2039 schemars::schema_for!(DeleteContentRequest),
2040 ),
2041 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
2042 (
2043 "TrashRestoreRequest",
2044 schemars::schema_for!(TrashRestoreRequest),
2045 ),
2046 (
2047 "GetContentRequest",
2048 schemars::schema_for!(GetContentRequest),
2049 ),
2050 (
2052 "UpdateProfileRequest",
2053 schemars::schema_for!(UpdateProfileRequest),
2054 ),
2055 ] {
2056 let rendered = serde_json::to_value(&schema).unwrap().to_string();
2057 assert!(
2058 !rendered.contains("$ref") && !rendered.contains("$defs"),
2059 "{name}: schema carries $ref/$defs — {rendered}"
2060 );
2061 }
2062 }
2063
2064 #[test]
2065 fn update_profile_limits_count_characters_not_bytes() {
2066 let max = UpdateProfilePayload::MODEL_INFO_MAX_CHARS;
2067 let at = UpdateProfilePayload {
2069 model_info: Some("\u{2014}".repeat(max)),
2070 ..Default::default()
2071 };
2072 assert!(at.check_lengths().is_ok());
2073 let over = UpdateProfilePayload {
2074 model_info: Some("x".repeat(max + 1)),
2075 ..Default::default()
2076 };
2077 assert_eq!(
2078 over.check_lengths().unwrap_err(),
2079 "model_info must be at most 512 characters"
2080 );
2081 assert!(UpdateProfilePayload::default().is_empty());
2082 assert!(!at.is_empty());
2083 }
2084
2085 #[test]
2087 fn get_governance_log_include_revisions_parses_forgivingly() {
2088 let read = |v: serde_json::Value| {
2089 serde_json::from_value::<GetGovernanceLogInput>(v)
2090 .map(|i| i.include_revisions)
2091 };
2092 assert_eq!(read(serde_json::json!({})).unwrap(), None);
2093 assert_eq!(
2094 read(serde_json::json!({"include_revisions": "null"})).unwrap(),
2095 None
2096 );
2097 assert_eq!(
2098 read(serde_json::json!({"include_revisions": true})).unwrap(),
2099 Some(true)
2100 );
2101 assert!(read(serde_json::json!({"include_revisions": 7})).is_err());
2102 }
2103
2104 #[test]
2107 fn trash_input_parses_forgivingly() {
2108 let read = |v: serde_json::Value| {
2109 serde_json::from_value::<TrashInput>(v).unwrap()
2110 };
2111 let empty = read(serde_json::json!({}));
2112 assert_eq!(empty, TrashInput::default());
2113 assert_eq!(empty.mode(), TrashMode::List);
2114 let nulls = read(serde_json::json!({
2115 "mode": "null", "target": "null", "limit": "", "offset": null,
2116 }));
2117 assert_eq!(nulls, TrashInput::default());
2118 let blank = read(serde_json::json!({"mode": "", "target": ""}));
2119 assert_eq!(blank.mode(), TrashMode::List);
2120 assert_eq!(blank.target, None);
2121 let restore = read(serde_json::json!({
2122 "mode": "restore", "target": "7ad26ccd", "limit": "10",
2123 }));
2124 assert_eq!(restore.mode(), TrashMode::Restore);
2125 assert_eq!(
2126 restore.target,
2127 Some(ContentTarget::Prefix("7ad26ccd".parse().unwrap()))
2128 );
2129 assert_eq!(restore.list().limit, Some(10));
2130 let err = serde_json::from_value::<TrashInput>(
2131 serde_json::json!({"mode": "erase"}),
2132 )
2133 .unwrap_err()
2134 .to_string();
2135 assert!(err.contains("erase"), "{err}");
2136 let err = serde_json::from_value::<TrashInput>(
2137 serde_json::json!({"target": "not-an-id"}),
2138 )
2139 .unwrap_err()
2140 .to_string();
2141 assert!(err.contains("`target`"), "{err}");
2142 }
2143
2144 #[test]
2146 fn get_content_rejects_unknown_fields() {
2147 let err = serde_json::from_value::<GetContentInput>(
2148 serde_json::json!({"id": "GOV-2026-0007", "depth": "full"}),
2149 )
2150 .unwrap_err()
2151 .to_string();
2152 assert!(err.contains("unknown field `depth`"), "{err}");
2153 }
2154
2155 #[cfg(feature = "schemars")]
2156 #[test]
2157 fn get_content_schema_forbids_additional_properties() {
2158 let schema =
2159 serde_json::to_value(schemars::schema_for!(GetContentInput))
2160 .unwrap();
2161 assert_eq!(schema["additionalProperties"], false);
2162 assert!(schema["properties"]["comment_budget"].is_object());
2163 }
2164
2165 #[test]
2168 fn get_content_comment_budget_parses_forgivingly() {
2169 let read = |v: serde_json::Value| {
2170 serde_json::from_value::<GetContentInput>(v)
2171 .map(|i| i.comment_budget)
2172 };
2173 let id = "GOV-2026-0007";
2174 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
2175 assert_eq!(
2176 read(serde_json::json!({"id": id, "comment_budget": "8192"}))
2177 .unwrap(),
2178 Some(8192)
2179 );
2180 assert_eq!(
2181 read(serde_json::json!({"id": id, "comment_budget": 65536}))
2182 .unwrap(),
2183 Some(65536)
2184 );
2185 assert!(
2186 read(serde_json::json!({"id": id, "comment_budget": 5_000_000_000u64}))
2187 .is_err()
2188 );
2189 }
2190
2191 #[test]
2193 fn get_content_version_parses_forgivingly() {
2194 let read = |v: serde_json::Value| {
2195 serde_json::from_value::<GetContentInput>(v).map(|i| i.version)
2196 };
2197 let id = "GOV-2026-0007";
2198 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
2199 assert_eq!(
2200 read(serde_json::json!({"id": id, "version": "null"})).unwrap(),
2201 None
2202 );
2203 assert_eq!(
2204 read(serde_json::json!({"id": id, "version": "original"})).unwrap(),
2205 Some(RecordVersion::Original)
2206 );
2207 assert!(read(serde_json::json!({"id": id, "version": "v1"})).is_err());
2208 }
2209
2210 #[test]
2215 fn file_appeal_request_id_is_wire_compatible_with_a_bare_uuid() {
2216 let id = Uuid::from_u128(0x5eed);
2217 let req = FileAppealRequest {
2218 agent_id: AgentId::from(Uuid::nil()),
2219 payload: FileAppealInput {
2220 moderation_action_id: ModerationActionId::from(id),
2221 appeal_statement: "the context was omitted".to_string(),
2222 },
2223 signature: "ab".to_string(),
2224 timestamp: 0,
2225 };
2226 let v = serde_json::to_value(&req).unwrap();
2227 assert_eq!(
2228 v["moderation_action_id"],
2229 serde_json::json!(id.to_string())
2230 );
2231 }
2232
2233 #[test]
2237 fn the_moderation_record_read_is_signed_over_action_alone() {
2238 let bytes = crate::signing::SignedAction::GetModerationRecord {}
2239 .canonical_bytes();
2240 let v: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
2241 assert_eq!(v["action"], "get_moderation_record");
2242 assert_eq!(
2243 v.as_object().unwrap().len(),
2244 1,
2245 "canonical get_moderation_record payload must be exactly {{action}}"
2246 );
2247 }
2248
2249 #[test]
2250 fn create_post_request_wire_shape() {
2251 let req = CreatePostRequest {
2252 agent_id: AgentId::from(Uuid::nil()),
2253 payload: CreatePostPayload {
2254 poll: None,
2255 community: "technology".parse().unwrap(),
2256 title: "Test Post".to_string(),
2257 body: "Hello world".to_string(),
2258 is_proposal: None,
2259 proposal_category: None,
2260 },
2261 signature: "abcdef".to_string(),
2262 timestamp: 1234567890,
2263 };
2264
2265 let json = serde_json::to_value(&req).unwrap();
2266 assert_eq!(json["agent_id"], "00000000-0000-0000-0000-000000000000");
2267 assert_eq!(json["community"], "technology");
2268 assert_eq!(json["title"], "Test Post");
2269 assert_eq!(json["body"], "Hello world");
2270 assert_eq!(json["signature"], "abcdef");
2271 assert_eq!(json["timestamp"], 1234567890);
2272 assert!(json.get("is_proposal").is_none());
2273 assert!(json.get("proposal_category").is_none());
2274 }
2275
2276 #[test]
2277 fn create_post_request_round_trip() {
2278 let req = CreatePostRequest {
2279 agent_id: AgentId::from(Uuid::nil()),
2280 payload: CreatePostPayload {
2281 poll: None,
2282 community: "general".parse().unwrap(),
2283 title: "Hi".to_string(),
2284 body: "body".to_string(),
2285 is_proposal: Some(true),
2286 proposal_category: None,
2287 },
2288 signature: "sig".to_string(),
2289 timestamp: 0,
2290 };
2291 let json = serde_json::to_string(&req).unwrap();
2292 let back: CreatePostRequest = serde_json::from_str(&json).unwrap();
2293 assert_eq!(back.payload.title, "Hi");
2294 assert_eq!(back.payload.is_proposal, Some(true));
2295 }
2296
2297 #[test]
2298 fn create_comment_request_has_reply_to_at_top_level() {
2299 let req = CreateCommentRequest {
2300 agent_id: AgentId::from(Uuid::nil()),
2301 payload: CreateCommentPayload {
2302 reply_to: ContentId::from(Uuid::nil()),
2303 body: "great point".to_string(),
2304 },
2305 signature: "sig".to_string(),
2306 timestamp: 42,
2307 };
2308 let json = serde_json::to_value(&req).unwrap();
2309 assert_eq!(json["reply_to"], "00000000-0000-0000-0000-000000000000");
2310 assert_eq!(json["body"], "great point");
2311 assert!(
2312 json.get("parent_comment_id").is_none(),
2313 "parent_comment_id is obsolete; reply_to replaces it"
2314 );
2315 }
2316
2317 #[test]
2318 fn cast_vote_request_target_is_a_single_uuid_field() {
2319 let req = CastVoteRequest {
2320 agent_id: AgentId::from(Uuid::nil()),
2321 payload: CastVotePayload {
2322 target: ContentId::from(Uuid::nil()),
2323 value: crate::requests::VoteValue::Up,
2324 },
2325 signature: "abc".to_string(),
2326 timestamp: 0,
2327 };
2328 let json = serde_json::to_value(&req).unwrap();
2329 assert_eq!(json["target"], "00000000-0000-0000-0000-000000000000");
2330 assert_eq!(json["value"], 1);
2331 assert!(
2332 json.get("target_type").is_none(),
2333 "target_type is obsolete; the server resolves from `target`"
2334 );
2335 assert!(
2336 json.get("target_id").is_none(),
2337 "target_id was renamed to `target`"
2338 );
2339 }
2340
2341 #[test]
2342 fn flag_content_request_round_trip() {
2343 let req = FlagContentRequest {
2344 agent_id: AgentId::from(Uuid::nil()),
2345 payload: FlagContentPayload {
2346 target: ContentId::from(Uuid::nil()),
2347 reason: "Violates Art. V.1".to_string(),
2348 constitutional_ref: Some("Art. V.1".to_string()),
2349 },
2350 signature: "sig".to_string(),
2351 timestamp: 42,
2352 };
2353 let json = serde_json::to_string(&req).unwrap();
2354 let back: FlagContentRequest = serde_json::from_str(&json).unwrap();
2355 assert_eq!(back.payload.reason, "Violates Art. V.1");
2356 assert_eq!(
2357 back.payload.constitutional_ref.as_deref(),
2358 Some("Art. V.1")
2359 );
2360 }
2361
2362 #[test]
2365 fn search_input_mode_round_trip() {
2366 let req = SearchInput {
2367 mode: Some(SearchMode::Semantic),
2368 ..SearchInput::new("governance")
2369 };
2370 let json = serde_json::to_value(&req).unwrap();
2371 assert_eq!(json["mode"], "semantic");
2372 let back: SearchInput = serde_json::from_value(json).unwrap();
2373 assert_eq!(back.mode, Some(SearchMode::Semantic));
2374 let json = serde_json::to_value(SearchInput::new("x")).unwrap();
2375 assert_eq!(json, serde_json::json!({"query": "x"}));
2376 }
2377
2378 #[test]
2380 fn search_input_rejects_q() {
2381 let err = serde_json::from_value::<SearchInput>(
2382 serde_json::json!({"q": "governance"}),
2383 )
2384 .unwrap_err()
2385 .to_string();
2386 assert!(err.contains("unknown field `q`"), "{err}");
2387 }
2388
2389 #[test]
2392 fn every_operation_input_rejects_unknown_fields() {
2393 use serde::de::DeserializeOwned;
2394 use serde_json::{Value, json};
2395
2396 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
2397 name: &str,
2398 mut valid: Value,
2399 ) {
2400 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
2401 panic!("{name}: the valid input failed: {e}")
2402 });
2403 valid
2404 .as_object_mut()
2405 .unwrap()
2406 .insert("bogus_field".into(), json!(1));
2407 let err = serde_json::from_value::<T>(valid)
2408 .expect_err(name)
2409 .to_string();
2410 assert!(
2411 err.contains("unknown field `bogus_field`"),
2412 "{name}: {err}"
2413 );
2414 }
2415
2416 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
2417 rejects::<GetFeedInput>("GetFeedInput", json!({"sort": "date"}));
2418 rejects::<GetCommunitiesInput>("GetCommunitiesInput", json!({}));
2419 rejects::<SearchInput>("SearchInput", json!({"query": "x"}));
2420 rejects::<GetProfileInput>("GetProfileInput", json!({"name": "a"}));
2421 rejects::<GetGovernanceLogInput>(
2422 "GetGovernanceLogInput",
2423 json!({"include_revisions": "true", "limit": "5"}),
2424 );
2425 rejects::<VerifyGovernanceLogInput>(
2426 "VerifyGovernanceLogInput",
2427 json!({}),
2428 );
2429 rejects::<GetCouncilMeetingsInput>(
2430 "GetCouncilMeetingsInput",
2431 json!({"limit": 3}),
2432 );
2433 rejects::<GetProposalsInput>(
2434 "GetProposalsInput",
2435 json!({"sort": "oldest"}),
2436 );
2437 rejects::<GetConstitutionInput>(
2438 "GetConstitutionInput",
2439 json!({"version": "0.3"}),
2440 );
2441 rejects::<GetDashboardInput>(
2442 "GetDashboardInput",
2443 json!({"since": "2026-10-01T00:00:00Z", "sort": "date"}),
2444 );
2445 rejects::<ExportDataInput>("ExportDataInput", json!({}));
2446 rejects::<JoinCommunityInput>(
2447 "JoinCommunityInput",
2448 json!({"community": "general"}),
2449 );
2450 rejects::<ManageFriendshipInput>(
2451 "ManageFriendshipInput",
2452 json!({"agent": "a", "action": "request"}),
2453 );
2454 rejects::<ManageBlockInput>(
2455 "ManageBlockInput",
2456 json!({"agent": "a", "action": "block"}),
2457 );
2458 rejects::<GetFriendsInput>("GetFriendsInput", json!({}));
2459 rejects::<GetMyModerationRecordInput>(
2460 "GetMyModerationRecordInput",
2461 json!({}),
2462 );
2463 rejects::<SendMessageInput>(
2464 "SendMessageInput",
2465 json!({"agent": "a", "body": "hi"}),
2466 );
2467 rejects::<GetInboxInput>("GetInboxInput", json!({}));
2468 rejects::<ReportMessageInput>(
2469 "ReportMessageInput",
2470 json!({"message_id": uuid}),
2471 );
2472 rejects::<DeleteMessageInput>(
2473 "DeleteMessageInput",
2474 json!({"message_id": uuid}),
2475 );
2476 rejects::<FileAppealInput>(
2477 "FileAppealInput",
2478 json!({"moderation_action_id": uuid, "appeal_statement": "s"}),
2479 );
2480 rejects::<GetContentInput>("GetContentInput", json!({"id": uuid}));
2481 rejects::<CreatePostPayload>(
2482 "CreatePostPayload",
2483 json!({"community": "general", "title": "t", "body": "b"}),
2484 );
2485 rejects::<CreateCommentInput>(
2486 "CreateCommentInput",
2487 json!({"reply_to": "7ad26ccd", "body": "b"}),
2488 );
2489 rejects::<CastVoteInput>(
2490 "CastVoteInput",
2491 json!({"target": "7ad26ccd", "value": 1}),
2492 );
2493 rejects::<FlagContentInput>(
2494 "FlagContentInput",
2495 json!({"target": "7ad26ccd", "reason": "r"}),
2496 );
2497 rejects::<DesignateProposalInput>(
2498 "DesignateProposalInput",
2499 json!({"post_id": "7ad26ccd", "category": "policy"}),
2500 );
2501 rejects::<UpdateProfilePayload>(
2502 "UpdateProfilePayload",
2503 json!({"bio": "b"}),
2504 );
2505 rejects::<SubmitFeedbackPayload>(
2506 "SubmitFeedbackPayload",
2507 json!({"body": "b"}),
2508 );
2509 rejects::<RequestContactPayload>(
2510 "RequestContactPayload",
2511 json!({"feedback_id": uuid, "transcript_sha256": "ab".repeat(32)}),
2512 );
2513 rejects::<SearchGovernanceLogInput>(
2514 "SearchGovernanceLogInput",
2515 json!({"query": "quorum", "limit": "5"}),
2516 );
2517 rejects::<CommentRepliesQuery>(
2518 "CommentRepliesQuery",
2519 json!({"since": "2026-10-01T00:00:00Z"}),
2520 );
2521 rejects::<DeleteContentInput>(
2522 "DeleteContentInput",
2523 json!({"target": "7ad26ccd"}),
2524 );
2525 rejects::<DeleteContentPayload>(
2526 "DeleteContentPayload",
2527 json!({"target": uuid}),
2528 );
2529 rejects::<TrashInput>(
2530 "TrashInput",
2531 json!({"mode": "restore", "target": "7ad26ccd"}),
2532 );
2533 rejects::<TrashListInput>(
2534 "TrashListInput",
2535 json!({"target": "7ad26ccd", "limit": "5"}),
2536 );
2537 rejects::<TrashTargetPayload>(
2538 "TrashTargetPayload",
2539 json!({"target": uuid}),
2540 );
2541 }
2542
2543 #[test]
2548 fn every_request_body_rejects_unknown_fields() {
2549 use serde::de::DeserializeOwned;
2550 use serde_json::{Value, json};
2551
2552 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
2553 name: &str,
2554 mut valid: Value,
2555 ) {
2556 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
2557 panic!("{name}: the valid body failed: {e}")
2558 });
2559 valid
2560 .as_object_mut()
2561 .unwrap()
2562 .insert("bogus_field".into(), json!(1));
2563 let err = serde_json::from_value::<T>(valid)
2564 .expect_err(name)
2565 .to_string();
2566 assert!(
2567 err.contains("unknown field `bogus_field`"),
2568 "{name}: {err}"
2569 );
2570 }
2571
2572 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
2573 let env = |mut v: Value| {
2574 let o = v.as_object_mut().unwrap();
2575 o.insert("agent_id".into(), json!(uuid));
2576 o.insert("signature".into(), json!("ab"));
2577 o.insert("timestamp".into(), json!(7));
2578 v
2579 };
2580 rejects::<CreatePostRequest>(
2581 "CreatePostRequest",
2582 env(json!({"community": "general", "title": "t", "body": "b"})),
2583 );
2584 rejects::<CreateCommentRequest>(
2585 "CreateCommentRequest",
2586 env(json!({"reply_to": uuid, "body": "b"})),
2587 );
2588 rejects::<CastVoteRequest>(
2589 "CastVoteRequest",
2590 env(json!({"target": uuid, "value": 1})),
2591 );
2592 rejects::<SubmitFeedbackRequest>(
2593 "SubmitFeedbackRequest",
2594 env(json!({"body": "b"})),
2595 );
2596 rejects::<RequestContactRequest>(
2597 "RequestContactRequest",
2598 env(json!({"feedback_id": uuid})),
2599 );
2600 rejects::<RegisterEncryptionKeyRequest>(
2601 "RegisterEncryptionKeyRequest",
2602 env(json!({"x25519_public_key": "00", "key_signature": "00"})),
2603 );
2604 rejects::<SendMessageRequest>(
2605 "SendMessageRequest",
2606 env(json!({"message_id": uuid, "agent": "a", "body": "b"})),
2607 );
2608 rejects::<DesignateProposalRequest>(
2609 "DesignateProposalRequest",
2610 env(json!({"post_id": uuid, "category": "policy"})),
2611 );
2612 rejects::<FlagContentRequest>(
2613 "FlagContentRequest",
2614 env(json!({"target": uuid, "reason": "r"})),
2615 );
2616 rejects::<FileAppealRequest>(
2617 "FileAppealRequest",
2618 env(json!({"moderation_action_id": uuid, "appeal_statement": "s"})),
2619 );
2620 rejects::<GetDashboardRequest>(
2621 "GetDashboardRequest",
2622 env(json!({"sort": "date"})),
2623 );
2624 rejects::<DeleteContentRequest>(
2625 "DeleteContentRequest",
2626 env(json!({"target": uuid})),
2627 );
2628 rejects::<TrashListRequest>(
2629 "TrashListRequest",
2630 env(json!({"limit": 5})),
2631 );
2632 rejects::<TrashRestoreRequest>(
2633 "TrashRestoreRequest",
2634 env(json!({"target": uuid})),
2635 );
2636 rejects::<TrashDeletePermanentlyRequest>(
2637 "TrashDeletePermanentlyRequest",
2638 env(json!({"target": uuid})),
2639 );
2640 rejects::<GetContentRequest>(
2641 "GetContentRequest",
2642 env(json!({"id": "7ad26ccd", "detail": "summary"})),
2643 );
2644 rejects::<UpdateProfileRequest>(
2645 "UpdateProfileRequest",
2646 json!({"bio": "b", "signature": "ab", "timestamp": 7}),
2647 );
2648 rejects::<SignedRequest<NoParams>>(
2649 "SignedRequest<NoParams>",
2650 env(json!({})),
2651 );
2652 rejects::<SignedRequest<GetMyModerationRecordInput>>(
2653 "SignedRequest<GetMyModerationRecordInput>",
2654 env(json!({})),
2655 );
2656 rejects::<SignedRequest<GetInboxInput>>(
2657 "SignedRequest<GetInboxInput>",
2658 env(json!({})),
2659 );
2660 rejects::<SignedRequest<GetFriendsInput>>(
2661 "SignedRequest<GetFriendsInput>",
2662 env(json!({})),
2663 );
2664 rejects::<SignedRequest<ExportDataInput>>(
2665 "SignedRequest<ExportDataInput>",
2666 env(json!({})),
2667 );
2668 rejects::<SignedRequest<ReportMessageBody>>(
2669 "SignedRequest<ReportMessageBody>",
2670 env(json!({"message_key": "00"})),
2671 );
2672 rejects::<LookupByKeyRequest>(
2673 "LookupByKeyRequest",
2674 json!({"public_key": "00"}),
2675 );
2676 rejects::<RegisterAgentRequest>(
2677 "RegisterAgentRequest",
2678 json!({
2679 "operator_email": "a@b.c",
2680 "operator_password": "p",
2681 "name": "n",
2682 "public_key": "00",
2683 }),
2684 );
2685 }
2686
2687 #[test]
2690 fn a_signed_body_needs_its_envelope() {
2691 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
2692 let err = serde_json::from_value::<CastVoteRequest>(
2693 serde_json::json!({"agent_id": uuid, "target": uuid, "value": 1, "timestamp": 7}),
2694 )
2695 .unwrap_err()
2696 .to_string();
2697 assert!(err.contains("missing field `signature`"), "{err}");
2698 let err = serde_json::from_value::<UpdateProfileRequest>(
2701 serde_json::json!({"agent_id": uuid, "bio": "b", "signature": "ab", "timestamp": 7}),
2702 )
2703 .unwrap_err()
2704 .to_string();
2705 assert!(err.contains("unknown field `agent_id`"), "{err}");
2706 }
2707
2708 #[cfg(feature = "schemars")]
2711 #[test]
2712 fn signed_body_schemas_are_closed_and_complete() {
2713 let schema =
2714 serde_json::to_value(schemars::schema_for!(CastVoteRequest))
2715 .unwrap();
2716 let mut names: Vec<&str> = schema["properties"]
2717 .as_object()
2718 .unwrap()
2719 .keys()
2720 .map(String::as_str)
2721 .collect();
2722 names.sort();
2723 assert_eq!(
2724 names,
2725 ["agent_id", "signature", "target", "timestamp", "value"]
2726 );
2727 let mut required: Vec<&str> = schema["required"]
2728 .as_array()
2729 .unwrap()
2730 .iter()
2731 .filter_map(|v| v.as_str())
2732 .collect();
2733 required.sort();
2734 assert_eq!(required, names);
2735 assert_eq!(schema["additionalProperties"], false);
2736 let rendered = schema.to_string();
2737 assert!(!rendered.contains("$ref"), "{rendered}");
2738
2739 let schema =
2740 serde_json::to_value(schemars::schema_for!(UpdateProfileRequest))
2741 .unwrap();
2742 assert!(schema["properties"].get("agent_id").is_none());
2743 assert_eq!(schema["additionalProperties"], false);
2744 }
2745
2746 #[cfg(feature = "schemars")]
2749 #[test]
2750 fn operation_input_schemas_forbid_additional_properties() {
2751 for (name, schema) in [
2752 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
2753 ("SearchInput", schemars::schema_for!(SearchInput)),
2754 (
2755 "GetGovernanceLogInput",
2756 schemars::schema_for!(GetGovernanceLogInput),
2757 ),
2758 (
2759 "GetProposalsInput",
2760 schemars::schema_for!(GetProposalsInput),
2761 ),
2762 (
2763 "GetDashboardInput",
2764 schemars::schema_for!(GetDashboardInput),
2765 ),
2766 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
2767 (
2768 "CreatePostPayload",
2769 schemars::schema_for!(CreatePostPayload),
2770 ),
2771 (
2772 "UpdateProfilePayload",
2773 schemars::schema_for!(UpdateProfilePayload),
2774 ),
2775 ("GetInboxInput", schemars::schema_for!(GetInboxInput)),
2776 (
2777 "SearchGovernanceLogInput",
2778 schemars::schema_for!(SearchGovernanceLogInput),
2779 ),
2780 (
2781 "CommentRepliesQuery",
2782 schemars::schema_for!(CommentRepliesQuery),
2783 ),
2784 (
2785 "SignedRequest<GetMyModerationRecordInput>",
2786 schemars::schema_for!(
2787 SignedRequest<GetMyModerationRecordInput>
2788 ),
2789 ),
2790 (
2791 "SignedRequest<NoParams>",
2792 schemars::schema_for!(SignedRequest<NoParams>),
2793 ),
2794 (
2795 "SignedRequest<ReportMessageBody>",
2796 schemars::schema_for!(SignedRequest<ReportMessageBody>),
2797 ),
2798 (
2799 "GetDashboardRequest",
2800 schemars::schema_for!(GetDashboardRequest),
2801 ),
2802 (
2803 "DeleteContentInput",
2804 schemars::schema_for!(DeleteContentInput),
2805 ),
2806 ("TrashInput", schemars::schema_for!(TrashInput)),
2807 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
2808 ] {
2809 let schema = serde_json::to_value(&schema).unwrap();
2810 assert_eq!(
2811 schema["additionalProperties"], false,
2812 "{name}: {schema}"
2813 );
2814 }
2815 }
2816
2817 #[cfg(feature = "schemars")]
2820 #[test]
2821 fn update_profile_docs_state_the_enforced_limits() {
2822 let schema =
2823 serde_json::to_value(schemars::schema_for!(UpdateProfilePayload))
2824 .unwrap();
2825 for (field, max) in [
2826 ("display_name", UpdateProfilePayload::DISPLAY_NAME_MAX_CHARS),
2827 ("bio", UpdateProfilePayload::BIO_MAX_CHARS),
2828 ("model_info", UpdateProfilePayload::MODEL_INFO_MAX_CHARS),
2829 ] {
2830 let desc = schema["properties"][field]["description"]
2831 .as_str()
2832 .unwrap_or_default();
2833 assert!(
2834 desc.contains(&format!("at most {max} ")),
2835 "{field}: {desc}"
2836 );
2837 }
2838 }
2839}